查询复制任务关联对比信息
通过复制任务 ID 查询该任务关联的全量数据对比、增量数据对比和结构对比任务。
请求地址:/openapi/v1/replication/compareTasks
请求方法:GET
调用前准备
- 按照 OpenAPI 接口文档 配置 AccessKey、请求时间戳和签名。
replicationId可通过查询复制任务获取。- 调用方需要同时具备
DataCompare(数据对比)和SchemaCompare(结构对比)模块权限。
请求参数
| 参数 | 位置 | 类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|---|
| replicationId | Query | String | 是 | 复制任务 ID。接口只查询当前 AccessKey 所属组织内该复制任务关联的对比任务。 | rp-example001 |
请求示例
GET 请求不包含请求体。请求参数可以按如下 JSON 结构准备,并将 replicationId 作为 Query 参数发送:
{
"replicationId": "rp-example001"
}
返回参数
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| success | Boolean | 请求是否成功。 | true |
| requestId | String | 请求 ID,可用于问题排查和链路追踪。 | <requestId> |
| data | Object | 成功时返回关联对比任务信息。请求失败时可能不返回。 | 见下方示例 |
| message | String | 业务请求失败时返回的错误信息。 | replication rp-example001 not found |
data 字段说明
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| replicationId | String | 请求中的复制任务 ID。 | rp-example001 |
| compareData | Array | 全量数据对比任务列表。 | 见下方示例 |
| compareIncData | Array | 增量数据对比任务列表。没有关联任务时返回空数组。 | [] |
| compareSchema | Array | 结构对比任务列表。 | 见下方示例 |
对比任务对象字段说明
compareData、compareIncData 和 compareSchema 数组中的元素包含以下字段。任务类型由元素所在的数组确定。
| 参数 | 类型 | 说明 | 示例 |
|---|---|---|---|
| id | String | 对比任务 ID。compareData 和 compareIncData 中的 ID 可用于数据对比接口;compareSchema 中的 ID 可用于结构对比接口。 | cd-example001 |
| referenceType | Number | 关联类型。复制任务关联的对比任务固定返回 1。 | 1 |
| status | String | 对比任务状态。 | success |
| isDeleted | Boolean | 对比任务是否已删除。 | 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
}
]
}
}