跳到主要内容

查询复制任务关联对比信息

通过复制任务 ID 查询该任务关联的全量数据对比、增量数据对比和结构对比任务。

请求地址:/openapi/v1/replication/compareTasks

请求方法:GET

调用前准备

  • 按照 OpenAPI 接口文档 配置 AccessKey、请求时间戳和签名。
  • replicationId 可通过查询复制任务获取。
  • 调用方需要同时具备 DataCompare(数据对比)和 SchemaCompare(结构对比)模块权限。

请求参数

参数位置类型是否必填说明示例
replicationIdQueryString复制任务 ID。接口只查询当前 AccessKey 所属组织内该复制任务关联的对比任务。rp-example001

请求示例

GET 请求不包含请求体。请求参数可以按如下 JSON 结构准备,并将 replicationId 作为 Query 参数发送:

{
"replicationId": "rp-example001"
}

返回参数

参数类型说明示例
successBoolean请求是否成功。true
requestIdString请求 ID,可用于问题排查和链路追踪。<requestId>
dataObject成功时返回关联对比任务信息。请求失败时可能不返回。见下方示例
messageString业务请求失败时返回的错误信息。replication rp-example001 not found

data 字段说明

参数类型说明示例
replicationIdString请求中的复制任务 ID。rp-example001
compareDataArray全量数据对比任务列表。见下方示例
compareIncDataArray增量数据对比任务列表。没有关联任务时返回空数组。[]
compareSchemaArray结构对比任务列表。见下方示例

对比任务对象字段说明

compareDatacompareIncDatacompareSchema 数组中的元素包含以下字段。任务类型由元素所在的数组确定。

参数类型说明示例
idString对比任务 ID。compareDatacompareIncData 中的 ID 可用于数据对比接口;compareSchema 中的 ID 可用于结构对比接口。cd-example001
referenceTypeNumber关联类型。复制任务关联的对比任务固定返回 11
statusString对比任务状态。success
isDeletedBoolean对比任务是否已删除。false

调用成功示例

{
"success": true,
"requestId": "<requestId>",
"data": {
"replicationId": "rp-example001",
"compareData": [
{
"id": "cd-example001",
"referenceType": 1,
"status": "success",
"isDeleted": false
}
],
"compareIncData": [],
"compareSchema": [
{
"id": "cc-example001",
"referenceType": 1,
"status": "success",
"isDeleted": false
}
]
}
}