更新时间:2026-05-11 GMT+08:00
分享

暂停对比任务 - PauseCompareJobs

功能介绍

暂停对比任务

授权信息

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

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

URI

POST /v5/{project_id}/jobs/{job_id}/compare/pause

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的Project ID。 获取方法请参见获取项目ID

job_id

String

任务ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

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

X-Auth-Token

String

从IAM服务获取的用户Token。用户Token也就是调用IAM获取用户Token接口的响应值,请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

String

请求语言类型。

表3 请求Body参数

参数

是否必选

参数类型

描述

compare_job_ids

Array of strings

操作的对比任务ID列表。

响应参数

状态码:202

表4 响应Body参数

参数

参数类型

描述

request_id

String

请求ID

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/7b35723d-1525-410e-90c3-70f9ed3jb601/compare/pause

{
  compare_job_ids:[
  "8c283eb4-65a9-4c6e-96fc-f268b0e3c443"
  ],
}

响应示例

状态码:202

Accepted

{
  "request_id" : "8c283eb4-65a9-4c6e-96fc-f268b0e3c443"
}

状态码:400

Bad Request

{
  "error_code" : "DRS.M10018",
  "error_msg" : "Current version does not support pause or restart compare job."
}

状态码

状态码

描述

202

Accepted

400

Bad Request

其他状态请参见状态码

错误码

请参见错误码

相关文档