Query Replication Task Options
Queries the current replication options of a specified replication task.
Request URL: /openapi/v1/replication/option
Request Method: GET
Request Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| replicationId | String | Yes | Replication task ID. | rp-div0t0awwobr |
Response Parameters
| Parameter | Type | Description | Example |
|---|---|---|---|
| success | Boolean | Whether the request was successful. | true |
| requestId | String | Request ID. | Ox1c9ULM-kqrjmSSnjnos3FWdlry0ADD |
| data | Object | Replication option details. | See the example below |
| data.replicationId | String | Replication task ID. | rp-div0t0awwobr |
| data.replicationOption | Object | Replication options. See replicationOption Fields. | See the example below |
replicationOption Fields
| Parameter | Type | Description | Example |
|---|---|---|---|
| migrateSchema | Boolean | Whether object schemas are replicated. | true |
| migrateData | Boolean | Whether existing data is replicated. | true |
| incrementalReplication | Boolean | Whether incremental data is replicated. | true |
| specType | String | Replication instance specification. Values: micro, small, medium, large, xlarge. | micro |
| conflictStrategy | String | Data or schema conflict handling strategy. Values: ignore, abort, replace, drop_create. | drop_create |
| supportDDL | Boolean | Whether DDL replication is supported. | true |
Successful Invocation Example
{
"success": true,
"requestId": "Ox1c9ULM-kqrjmSSnjnos3FWdlry0ADD",
"data": {
"replicationId": "rp-div0t0awwobr",
"replicationOption": {
"migrateSchema": true,
"migrateData": true,
"incrementalReplication": true,
"specType": "micro",
"conflictStrategy": "drop_create",
"supportDDL": true
}
}
}