文档首页/ 编译构建 CodeArts Build/ API参考/ 任务相关API接口/ 禁用任务
更新时间：2024-11-08 GMT+08:00
在线调试
CLI示例
查看PDF
分享

禁用任务

功能介绍

禁用任务

调用方法

请参见如何调用API。

URI

POST /v1/job/{job_id}/disable

表1 路径参数

参数

是否必选

参数类型

描述

job_id

是

String

构建的任务ID；

编辑构建任务时，浏览器URL末尾的32位数字、字母组合的字符串。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

reason

否

String

禁用原因

disabled

是

Boolean

是否禁用

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

status

String

返回状态信息

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 401

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 404

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

POST https://{endpoint}/v1/job/b4d3971c3988463b865f6f920846149e/disable

响应示例

状态码： 200

OK

{
  "status" : "success"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 任务相关API接口

相关文档