文档首页/数据复制服务 DRS/API参考/API v5（公测中）/对比管理/获取健康对比对象级对比概览 - ShowHealthObjectCompareJobOverview
更新时间：2025-12-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取健康对比对象级对比概览 - ShowHealthObjectCompareJobOverview

功能介绍

获取健康对比对象级对比概览。

授权信息

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

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

URI

GET /v5/{project_id}/jobs/{job_id}/health-compare-jobs/object/{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是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。

缺省值：application/json

X-Auth-Token

是

String

从IAM服务获取的用户Token。

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

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

X-Language

否

String

请求语言类型。

缺省值：en-us

枚举值：

  • en-us
  • zh-cn

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

compare_result

Array of objects

健康对比对象级对比结果。

详情请参见表4

表4 compare_result参数说明

参数

参数类型

描述

type

String

对象类型。取值：

  • DB：数据库。
  • TABLE：表。
  • VIEW：视图。
  • EVENT：事件。
  • ROUTINE：存储过程和函数。
  • INDEX：索引。
  • TRIGGER：触发器。
  • SYNONYM：同义词。
  • FUNCTION：函数。
  • PROCEDURE：存储过程。
  • TYPE：自定义类型。
  • RULE：规则。
  • DEFAULT_TYPE：缺省值。
  • PLAN_GUIDE：执行计划。
  • CONSTRAINT：约束。
  • FILE_GROUP：文件组。
  • PARTITION_FUNCTION：分区函数。
  • PARTITION_SCHEME：分区方案。
  • TABLE_COLLATION：表的排序规则。
  • EXTENSIONS：插件。

source_count

Long

源数量。

target_count

Long

目标数量。

status

Integer

对比结果：

  • 0：不一致。
  • 2：一致。
  • 3：未完成。

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度：12

最大长度：12

error_msg

String

错误描述。

最小长度：1

最大长度：512

请求示例

获取健康对比对象级对比概览请求示例。

https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/163b98e8-6088-46c3-8b86-c18fea6jb502/health-compare-jobs/object/118d1bdc-b3c8-48a0-af77-3400da6e9291

响应示例

状态码：200

OK

{
  "compare_result" : [ {
    "type" : "DB",
    "status" : 2,
    "source_count" : 1,
    "target_count" : 1
  }, {
    "type" : "INDEX",
    "status" : 2,
    "source_count" : 2,
    "target_count" : 2
  }, {
    "type" : "TABLE",
    "status" : 2,
    "source_count" : 2,
    "target_count" : 2
  }, {
    "type" : "TABLE_COLLATION",
    "status" : 2,
    "source_count" : 2,
    "target_count" : 2
  } ]
}

状态码：400

Bad Request

{
  "error_code" : "DRS.10000001",
  "error_msg" : "Failed."
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码。

父主题：对比管理

相关文档