文档首页/视频智能分析服务 VIAS/API参考/平台API/任务中心/启动/停止批量配置任务 - BatchStartStopTask
更新时间：2025-12-18 GMT+08:00
在线调试
CLI示例
查看PDF
分享

启动/停止批量配置任务 - BatchStartStopTask

功能介绍

启动/停止批量配置任务。

调试

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

URI

PUT /v2/{project_id}/batch-tasks/{id}/action/{command}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

用户项目ID，获取方法参见获取项目ID和名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

id

是

String

参数解释：

批量配置ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

command

是

String

参数解释：

指定该API要对批量任务配置进行的操作。

约束限制：

不涉及。

取值范围：

  • start（启动批量任务）

  • stop（停止批量任务）

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token，获取方法参见认证鉴权。

约束限制：

不涉及。

取值范围：

字符串长度[0, 32768]。

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

total_count

Integer

参数解释：

作业总数。

取值范围：

不涉及。

failed_count

Integer

参数解释：

失败作业数量。

取值范围：

不涉及。

succeed_count

Integer

参数解释：

成功作业数量。

取值范围：

不涉及。

id

String

参数解释：

批量作业id。

取值范围：

不涉及。

error_list

Array of strings

参数解释：

错误信息列表。

取值范围：

不涉及。

状态码：400

表4 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误信息描述。

取值范围：

不涉及。

detail

String

参数解释：

错误详情。

取值范围：

不涉及。

params

Array of strings

参数解释：

错误参数列举。

取值范围：

列表长度[0, 1]。

reason

String

参数解释：

错误原因。

取值范围：

不涉及。

advice

String

参数解释：

建议。

取值范围：

不涉及。

状态码：500

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误信息描述。

取值范围：

不涉及。

detail

String

参数解释：

错误详情。

取值范围：

不涉及。

params

Array of strings

参数解释：

错误参数列举。

取值范围：

列表长度[0, 1]。

reason

String

参数解释：

错误原因。

取值范围：

不涉及。

advice

String

参数解释：

建议。

取值范围：

不涉及。

请求示例

对批量配置ID为{id}做启动/停止动作

 /v2/{project_id}/batch-tasks/{id}/action/{command}

https://{endpoint}/v2/{project_id}/batch-tasks/0d47bbf52962414bb7ae27fb6ea24230/action/{command}?

响应示例

状态码：200

批量操作响应体。

{
  "total_count" : 1,
  "failed_count" : 0,
  "succeed_count" : 1,
  "id" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "error_list" : [ ]
}

状态码

状态码

描述

200

批量操作响应体。

400

请求错误。

500

内部错误。

父主题：任务中心

相关文档