文档首页/数据复制服务 DRS/API参考/API v5（公测中）/对比管理/查询对比任务进度 - ShowCompareProgress
更新时间：2025-12-04 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询对比任务进度 - ShowCompareProgress

功能介绍

查询运行中对比任务的对比进度。

说明：

  • 目前仅MySQL->MySQL、MySQL->GaussDB主备、GaussDB分布式->GaussDB分布式、GaussDB主备->MySQL、GaussDBv1->GaussDB主备、GaussDB主备->GaussDBv1的同步任务与独立校验任务支持查看对比进度。
  • 运行中的行对比与内容对比支持。

接口约束

仅支持部分Region使用，详情参考终端节点。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/jobs/{job_id}/compare-progress/{compare_job_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的Project ID。

获取方法请参见获取项目ID。

job_id

是

String

任务ID。

compare_job_id

是

String

对比任务ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。

X-Auth-Token

是

String

从IAM服务获取的用户Token。

用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

否

String

请求语言类型。

-en-us：英文

-zh-cn：中文

枚举值：

  • en-us
  • zh-cn

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

full_info

object

行对比与内容对比会返回该字段，全量对比信息。详情请参见表4。

incre_info

object

动态内容对比会返回该字段，增量对比信息。详情请参见表5。

global_info

object

全局对比信息。详情请参见表6。

表4 full_info

参数

参数类型

描述

progress

Float

全量数据对比进度，单位为%。

src_speed

String

全量数据对比速率。

recheck_entities

Integer

差异待复查行数。

表5 incre_info

参数

参数类型

描述

delay

Float

增量对比时延，若时延为0表示所有增量数据都已对比完成。

src_speed

String

增量数据对比速率。

rps

Integer

每秒对比行数。

log_point

String

增量位点。

recheck_entities

Integer

差异待复查行数。

表6 global_info

参数

参数类型

描述

src_speed

String

全局对比速率。

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

查询运行中对比任务的对比进度请求示例。

https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/9cbfd380-bdb1-43b2-9db9-3de2987jb201/compare-progress/b13b233a-4b9e-4b06-a928-19a0c93f6109

响应示例

状态码：200

OK

{ 
  "full_info" : { 
    "progress" : 100, 
    "src_speed" : "0.00B/s", 
    "recheck_entities" : 0 
  }, 
  "incre_info" : { 
    "delay" : 9.58, 
    "src_speed" : "0.00B/s", 
    "rps" : 0, 
    "log_point" : "951de1d2-61ee-11f0-8081-fa163ef20ddd:51", 
    "recheck_entities" : 0 
  }, 
  "global_info" : { 
    "src_speed" : "0.00B/s" 
  } 
}

状态码：400

Bad Request

{ 
  "error_code" : "DRS.10000010", 
  "error_msg" : "Task information not found." 
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码。

父主题：对比管理