创建结构对比任务

用于创建结构对比任务，并指定源端、目标端以及需要对比的对象范围。

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

请求方法：POST

调用前准备

• sourceDsId 和 targetDsId 可通过 获取数据源列表 返回结果中的 data[].datasourceId 获取。
• objectConfig 的对象范围结构与 创建数据对比任务 中的 objectConfig 保持一致，可通过 databaseList、schemaList、tableList 等字段指定库、Schema、表和对象映射关系。
• 如果需要创建周期性结构对比任务，请将 taskType 设置为 PERIODIC，并传入 scheduleConfig。

请求参数

参数	类型	是否必填	说明	示例
taskName	String	是	结构对比任务名称。	schema_compare_demo
sourceDsId	String	是	源端数据源 ID。	ds-ct192k3jlj4f
targetDsId	String	是	目标端数据源 ID。	ds-d37s953l33d3
objectConfig	JSON	是	需要对比的对象范围配置。字段结构与 创建数据对比任务 的 objectConfig 一致。	见下方示例
taskType	String	否	调度类型。ONETIME 表示一次性对比，PERIODIC 表示周期性对比。默认值为 ONETIME。	ONETIME
scheduleConfig	Object	否	周期性对比配置。仅 taskType=PERIODIC 时传入，字段见下方说明。	见下方示例

scheduleConfig 字段说明

参数	类型	是否必填	说明	示例
scheduleType	String	否	周期性对比时固定传入 periodic。	periodic
days	String[]	否	调度运行的星期。可选值包括 MONDAY、TUESDAY、WEDNESDAY、THURSDAY、FRIDAY、SATURDAY、SUNDAY。	["MONDAY","TUESDAY"]
startTimeOfDay	String	否	每个调度日的启动时间，格式为 HH:mm。默认值为 01:00。	11:31
timezone	String	否	启动时间对应的时区。默认值为 +08:00_CST。	+08:00_CST

请求示例

{
  "taskName": "schema_compare_demo",
  "sourceDsId": "ds-ct192k3jlj4f",
  "targetDsId": "ds-d37s953l33d3",
  "taskType": "ONETIME",
  "objectConfig": {
    "all": false,
    "allDatabase": false,
    "databaseList": [
      {
        "objectType": "database",
        "databaseName": "9zdbtest2",
        "targetDatabase": "9zdbtest3",
        "all": false,
        "tableList": [
          {
            "databaseName": "9zdbtest2",
            "targetDatabase": "9zdbtest3",
            "tableName": "sbtest1",
            "targetTable": "sbtest1"
          }
        ]
      }
    ],
    "migrateTrigger": false,
    "migrateEvent": false
  }
}

周期性任务 scheduleConfig 示例

{
  "scheduleType": "periodic",
  "days": [
    "MONDAY",
    "TUESDAY",
    "WEDNESDAY",
    "THURSDAY",
    "FRIDAY",
    "SATURDAY",
    "SUNDAY"
  ],
  "startTimeOfDay": "11:31",
  "timezone": "+08:00_CST"
}

返回参数

参数	类型	说明	示例
success	Boolean	请求是否成功。	true
requestId	String	请求 ID，可用于问题排查和链路追踪。	Fw5n8KVE-jpqkrAKnlppo9DXdknc3IUH
data	Object	创建结果，字段见下方说明。	见下方示例
message	String	错误信息。请求失败时返回。	taskName is required

data 字段说明

参数	类型	说明	示例
taskId	String	新创建的结构对比任务 ID。	cc-th6j3fs58y

调用成功示例

{
  "success": true,
  "requestId": "Fw5n8KVE-jpqkrAKnlppo9DXdknc3IUH",
  "data": {
    "taskId": "cc-th6j3fs58y"
  }
}