文档首页> 数据复制服务 DRS> API参考> API v3（不再推广）> 公共接口管理> 批量暂停任务
更新时间：2023-09-13 GMT+08:00
在线调试
CLI示例
查看PDF

批量暂停任务

功能介绍

批量暂停任务。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

接口约束

  • 迁移中、同步中、灾备中的任务可以执行暂停动作。
  • 双主灾备时，父任务不支持调用。

URI

POST /v3/{project_id}/jobs/batch-pause-task

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的Project ID。

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

指定类型为application/json。

缺省值：application/json

X-Auth-Token

是

String

从IAM服务获取的用户Token。

X-Language

否

String

请求语言类型。

缺省值：en-us

取值：

  • en-us
  • zh-cn
表3 请求Body参数

参数

是否必选

参数类型

描述

jobs

是

Array of objects

不能包含空对象。 集合中的job_id取值严格匹配UUID规则。

详情请参见表4。
表4 jobs字段数据结构说明

参数

是否必选

参数类型

描述

job_id

是

String

任务ID。

pause_mode

是

String

暂停类型，target：停回放，all：停日志抓取和回放。

取值：

  • target
  • all

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

results

Array of objects

批量暂停返回列表。

详情请参见表6。

count

Integer

总数。
表6 results字段数据结构说明

参数

参数类型

描述

id

String

任务ID。

status

String

暂停结果。

error_code

String

错误码。

error_msg

String

错误信息。

请求示例

批量暂停指定任务

https://{endpoint}/v3/054ba152d480d55b2f5dc0069e7ddef0/jobs/batch-pause-task

{
  "jobs" : [ {
    "job_id" : "8d0e8e36-a618-490d-8a46-8c61ac9jb502",
    "pause_mode" : "target"
  } ]
}

响应示例

状态码： 200

OK

{
  "results" : [ {
    "id" : "8d0e8e36-a618-490d-8a46-8c61ac9jb502",
    "status" : "success"
  } ],
  "count" : 1
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码。

父主题： 公共接口管理