更新时间:2022-10-20 GMT+08:00

批量暂停转储任务

功能介绍

此接口用于批量暂停转储任务。

URI

POST /v2/{project_id}/streams/{stream_name}/transfer-tasks/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

stream_name

String

需要查询的通道名称。

最大长度:60

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

action

String

转储任务操作,目前支持:

  • stop:停止转储任务

枚举值:

  • stop

tasks

Array of BatchTransferTask objects

待暂停的转储任务列表。

表3 BatchTransferTask

参数

是否必选

参数类型

描述

id

String

转储任务ID

响应参数

请求示例

批量暂停转储任务

POST https://{Endpoint}/v2/{project_id}/streams/{stream_name}/transfer-tasks/action

{
  "action" : "stop",
  "tasks" : [ {
    "id" : "9dSu1wfCytSk1aOLxvF"
  } ]
}

响应示例

状态码

状态码

描述

200

正常返回

错误码

请参见错误码