文档首页/ 代码检查 CodeArts Check/ API参考/ API/ 任务管理/ 删除任务
更新时间：2025-09-29 GMT+08:00
在线调试
CLI示例
查看PDF
分享

删除任务

功能介绍

删除任务。

调用方法

请参见如何调用API。

URI

DELETE /v3/task/{task_id}

表1 路径参数

参数

是否必选

参数类型

描述

task_id

是

String

参数解释：

任务ID，即新建检查任务接口的返回值，每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

operator

否

String

参数解释：

操作者。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

httpStatus

String

参数解释：

HTTP响应状态，接口响应成功时为"OK"，接口响应失败时为其他HTTP状态码。如INTERNAL_SERVER_ERROR为接口内部异常，BAD_REQUEST是参数校验异常。

取值范围：

  • OK，接口响应成功。

  • ACCEPTED，接口响应成功。

  • INTERNAL_SERVER_ERROR，接口内部异常。

  • BAD_REQUEST，参数校验异常。

result

String

参数解释：

删除成功时，result为"true"。

取值范围：

不涉及。

status

String

参数解释：

接口响应状态。

取值范围：

  • success，接口响应成功。

  • error，接口响应失败。

请求示例

删除任务ID为897acf5exxx48a5013cd的代码检查任务。

DELETE https://{endpoint}/v3/task/897acf5exxx48a5013cd

响应示例

状态码：200

删除任务成功

{
  "httpStatus" : "OK",
  "result" : true,
  "status" : "success"
}

状态码

状态码

描述

200

删除任务成功

错误码

请参见错误码。

父主题： 任务管理

相关文档