查询健康对比列表 - ShowHealthCompareJobList
功能介绍
查询健康对比列表。
接口约束
仅支持部分Region使用，详情参考终端节点。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/jobs/{job_id}/health-compare-jobs
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 |
job_id | 是 | String | 任务ID。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
status | 否 | String | 状态，不传查询所有状态。
枚举值：
|
limit | 否 | String | 每页显示的条目数量。默认为10，取值范围【1-1000】 最小值：1 最大值：1000 缺省值：10 |
offset | 否 | String | 偏移量，表示从此偏移量开始查询， offset 大于等于 0。默认为0 缺省值：0 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
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 枚举值：
|
响应参数
状态码：200
参数 | 参数类型 | 描述 |
|---|---|---|
count | Integer | 总数。 |
compare_jobs | Array of objects | 健康对比任务列表。 详情请参见表5。 |
参数 | 参数类型 | 描述 |
|---|---|---|
id | String | 任务ID。 |
type | String | 对比类型。 |
start_time | String | 对比开始时间。 |
end_time | String | 对比结束时间。 |
status | String | 状态。
|
compute_type | String | 对比计算资源。 |
状态码：400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码。 最小长度：12 最大长度：12 |
error_msg | String | 错误描述。 最小长度：1 最大长度：512 |
请求示例
查询健康对比列表请求示例。
https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/163b98e8-6088-46c3-8b86-c18fea6jb502/health-compare-jobs?offset=1&limit=10 响应示例
状态码：200
{
"count": 1,
"compare_jobs": [
{
"id": "cd05434c-ad91-479c-a8d3-d90d58eccc43",
"type": "lines,account,object_comparison",
"status": "SUCCESSFUL",
"start_time": "1686038400512",
"end_time": "1686038408711",
"compute_type": "drs"
}
]
} 状态码：400
Bad Request
{
"error_code": "DRS.M05003",
"error_msg": "Task information not found."
} 错误码
请参见错误码。
