跳到主要内容

创建数据对比任务

用于创建数据对比任务，支持选择源端和目标端数据源，以及需要对比的库表范围。

请求地址：/openapi/v1/comparedata/create

请求方法：POST

请求参数​

参数类型是否必选说明示例
nameString是任务名称。codex-compare-1775716827866
sourceDsIdString是源端数据源 ID，可调用获取数据源列表接口查询。ds-d8k4ch8yj9o0
targetDsIdString是目标端数据源 ID，可调用获取数据源列表接口查询。ds-d8k49pw2xbcf
taskModeString是对比类型。当前文档中已说明的取值：FULL 表示全量对比。FULL
objectConfigObject是对比对象配置，字段说明见本文的 objectConfig 字段说明。{
"all": false,
"databaseList": []
}

objectConfig 字段说明​

参数类型是否必选说明示例
allBoolean是是否选取整个实例下全部对象。false
databaseListArray否按库维度选择需要对比的对象列表。all=false 时使用。字段说明见 databaseList 字段说明。[{...}]

databaseList 字段说明​

参数类型是否必选说明示例
databaseNameString是源端数据库名称。sample_employees_337
targetDatabaseString是目标端数据库名称。sample_employees_337
allBoolean是是否选取该库下全部表。true
tableListArray否需要对比的数据表列表。all=false 时使用。字段说明见 tableList 字段说明。[{...}]

tableList 字段说明​

参数类型是否必选说明示例
tableNameString是源端表名称。departments
targetTableString是目标端表名称。departments

请求示例​

{
  "name": "codex-compare-1775716827866",
  "sourceDsId": "ds-d8k4ch8yj9o0",
  "targetDsId": "ds-d8k49pw2xbcf",
  "taskMode": "FULL",
  "objectConfig": {
    "all": false,
    "allDatabase": false,
    "databaseList": [
      {
        "all": true,
        "databaseName": "sample_employees_337",
        "ddlTriggerList": [],
        "eventList": [],
        "functionList": [],
        "objectFullName": "sample_employees_337",
        "objectName": "sample_employees_337",
        "objectType": "DATABASE",
        "otherStoredObjectList": [],
        "procedureList": [],
        "tableList": [
          {
            "objectFullName": "departments",
            "objectName": "departments",
            "objectType": "TABLE",
            "tableName": "departments",
            "targetDatabase": "sample_employees_337",
            "targetName": "departments",
            "targetTable": "departments"
          },
          {
            "objectFullName": "dept_emp",
            "objectName": "dept_emp",
            "objectType": "TABLE",
            "tableName": "dept_emp",
            "targetDatabase": "sample_employees_337",
            "targetName": "dept_emp",
            "targetTable": "dept_emp"
          },
          {
            "objectFullName": "dept_manager",
            "objectName": "dept_manager",
            "objectType": "TABLE",
            "tableName": "dept_manager",
            "targetDatabase": "sample_employees_337",
            "targetName": "dept_manager",
            "targetTable": "dept_manager"
          },
          {
            "objectFullName": "employees",
            "objectName": "employees",
            "objectType": "TABLE",
            "tableName": "employees",
            "targetDatabase": "sample_employees_337",
            "targetName": "employees",
            "targetTable": "employees"
          },
          {
            "objectFullName": "salaries",
            "objectName": "salaries",
            "objectType": "TABLE",
            "tableName": "salaries",
            "targetDatabase": "sample_employees_337",
            "targetName": "salaries",
            "targetTable": "salaries"
          }
        ],
        "targetDatabase": "sample_employees_337",
        "targetName": "sample_employees_337",
        "viewList": []
      }
    ],
    "migrateEvent": true,
    "migrateTrigger": true
  }
}

返回参数​

参数类型说明示例
successBoolean请求是否成功。true
requestIdString请求 ID。Cv8i6FVH-HNNLmSTnNHMj2CDdOGs6YLG
dataString数据对比任务 ID。cd-td7rupk2ps

调用成功示例​

{
  "success": true,
  "requestId": "Cv8i6FVH-HNNLmSTnNHMj2CDdOGs6YLG",
  "data": "cd-td7rupk2ps"
}