更新时间:2024-04-22 GMT+08:00

任务启停

功能介绍

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

task_id

String

已创建成功任务的id信息

command

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

响应参数

状态码: 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

内部错误

错误码

请参见错误码