跳到主要内容

修改复制任务

修改指定复制任务的源端和目标端数据源、复制参数以及复制对象范围。

请求地址：/openapi/v1/replication/update

请求方法：POST

使用限制​

  • 仅支持修改未启动的复制任务。
  • 暂不支持通过 OpenAPI 修改复制任务规格。

请求参数​

参数类型是否必选说明示例
replicationIdString是复制任务 ID。rp-div1e4z3z3g3
sourceDatasourceTypeString是源数据源类型。mongodb
sourceDatasourceIdString是源数据源 ID，可调用获取数据源列表查询。ds-source001
targetDatasourceTypeString是目标数据源类型。mongodb
targetDatasourceIdString是目标数据源 ID，可调用获取数据源列表查询。ds-target001
replicationOptionObject是复制任务配置参数，字段见replicationOption 字段说明。见下方示例
objectConfigObject是复制对象范围配置，字段见objectConfig 字段说明。见下方示例

replicationOption 字段说明​

参数类型是否必选说明示例
migrateSchemaBoolean否是否复制对象结构，默认值为 true。true
migrateDataBoolean否是否复制存量数据，默认值为 true。true
incrementalReplicationBoolean否是否复制增量数据，默认值为 false。false
conflictStrategyString是数据或结构冲突处理策略，取值为 ignore、abort、replace、drop_create。ignore
supportDDLBoolean否是否支持 DDL 复制，默认值为 true。双向复制的反向任务固定为 false。true

objectConfig 字段说明​

参数类型是否必选说明示例
allBoolean否是否包含实例下的全部对象，默认值为 false。设置为 true 时无需传入 databaseList。true
databaseListArray否数据库对象列表。all=false 时必填，元素字段见库或 Schema 对象字段说明。见下方示例

库或 Schema 对象字段说明​

databaseList 和 schemaList 使用相同的对象结构。源端为“库 > 表”两层结构时，databaseList 元素表示库；源端为“库 > Schema > 表”三层结构时，schemaList 元素表示 Schema。

参数类型是否必选说明示例
allBoolean否是否包含当前库或 Schema 下的全部对象，默认值为 false。false
allTableBoolean否是否包含全部表，默认值为 false。true
allViewBoolean否是否包含全部视图，默认值为 false。false
allTriggerBoolean否是否包含全部触发器，默认值为 false。false
allEventBoolean否是否包含全部事件，默认值为 false。false
allFunctionBoolean否是否包含全部函数，默认值为 false。false
allProcedureBoolean否是否包含全部存储过程，默认值为 false。false
schemaListArray否Schema 对象列表。源端为三层结构时使用，元素字段同本表。见下方示例
tableListArray否指定表对象列表，元素字段见一般对象字段说明。见下方示例
viewListArray否指定视图对象列表，元素字段见一般对象字段说明。见下方示例
functionListArray否指定函数对象列表，元素字段见一般对象字段说明。见下方示例
procedureListArray否指定存储过程对象列表，元素字段见一般对象字段说明。见下方示例
eventListArray否指定事件对象列表，元素字段见一般对象字段说明。见下方示例
triggerListArray否指定触发器对象列表，元素字段见一般对象字段说明。见下方示例
ddlTriggerListArray否指定 DDL 触发器对象列表，元素字段见一般对象字段说明。见下方示例
otherStoredObjectListArray否指定其他存储对象列表，元素字段见一般对象字段说明。见下方示例

一般对象字段说明​

参数类型是否必选说明示例
databaseNameString是源端库名。db1
targetDatabaseString否目标端库名，默认与 databaseName 一致。db1_target
schemaNameString否源端 Schema 名。源端为三层结构时可配置，默认值为 null。public
targetSchemaString否目标端 Schema 名。目标端为三层结构时可配置，默认值为 null。public_target
objectNameString是源端对象名。table_a
targetNameString否目标端对象名，默认与 objectName 一致。table_a_target

请求示例​

{
  "replicationId": "rp-div1e4z3z3g3",
  "sourceDatasourceType": "mongodb",
  "sourceDatasourceId": "ds-source001",
  "targetDatasourceType": "mongodb",
  "targetDatasourceId": "ds-target001",
  "replicationOption": {
    "migrateSchema": true,
    "migrateData": true,
    "incrementalReplication": false,
    "conflictStrategy": "ignore",
    "supportDDL": true
  },
  "objectConfig": {
    "all": true
  }
}

返回参数​

参数类型说明示例
successBoolean请求是否成功。true
requestIdString请求 ID。Tx1k9FHP-kqrjyGGnjnoo9QBdlsc3XBX
messageString失败时返回的提示信息。replication rp-xxx not found

调用成功示例​

{
  "success": true,
  "requestId": "Tx1k9FHP-kqrjyGGnjnoo9QBdlsc3XBX"
}