Skip to main content

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

ParameterTypeRequiredDescriptionExample
replicationIdStringYesReplication task ID.rp-div0t0awwobr

Response Parameters

ParameterTypeDescriptionExample
successBooleanWhether the request was successful.true
requestIdStringRequest ID.Ox1c9ULM-kqrjmSSnjnos3FWdlry0ADD
dataObjectReplication option details.See the example below
data.replicationIdStringReplication task ID.rp-div0t0awwobr
data.replicationOptionObjectReplication options. See replicationOption Fields.See the example below

replicationOption Fields

ParameterTypeDescriptionExample
migrateSchemaBooleanWhether object schemas are replicated.true
migrateDataBooleanWhether existing data is replicated.true
incrementalReplicationBooleanWhether incremental data is replicated.true
specTypeStringReplication instance specification. Values: micro, small, medium, large, xlarge.micro
conflictStrategyStringData or schema conflict handling strategy. Values: ignore, abort, replace, drop_create.drop_create
supportDDLBooleanWhether 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
}
}
}