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

任务启停 - StartStopTask

功能介绍

该接口用于启动或停止任务。

调试

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

URI

PUT /v2/{project_id}/tasks/{task_id}/action/{command}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

task_id

是

String

参数解释：

已创建成功任务的id信息。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

command

是

String

参数解释：

指定该API要对任务进行的操作，停止或者启动。

约束限制：

不涉及。

取值范围：

  • start

  • stop

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

字符串长度[0, 32768]。

默认取值：

不涉及。

响应参数

状态码：200

任务操作成功。

状态码：400

表3 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误信息描述。

取值范围：

不涉及。

detail

String

参数解释：

错误详情。

取值范围：

不涉及。

params

Array of strings

参数解释：

错误参数列举。

取值范围：

列表长度[0, 1]。

reason

String

参数解释：

错误原因。

取值范围：

不涉及。

advice

String

参数解释：

建议。

取值范围：

不涉及。

状态码：500

表4 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误信息描述。

取值范围：

不涉及。

detail

String

参数解释：

错误详情。

取值范围：

不涉及。

params

Array of strings

参数解释：

错误参数列举。

取值范围：

列表长度[0, 1]。

reason

String

参数解释：

错误原因。

取值范围：

不涉及。

advice

String

参数解释：

建议。

取值范围：

不涉及。

请求示例

  • 对任务ID为{task_id}的任务做停止操作

    /v2/{project_id}/tasks/{task_id}/action/{command}

{
  "id" : "String",
  "status_code" : 200,
  "status_msg" : "success"
}

  • 对任务ID为{task_id}的任务做启动操作

    /v2/{project_id}/tasks/{task_id}/action/{command}

{
  "id" : "String",
  "status_code" : 200,
  "status_msg" : "success"
}

响应示例

无

状态码

状态码

描述

200

任务操作成功。

400

请求错误。

500

内部错误。

父主题：任务中心

相关文档