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

取消检查

功能介绍

取消检查。

调用方法

请参见如何调用API。

URI

PUT /v1/tasks/{task_id}/stop

表1 路径参数

参数

是否必选

参数类型

描述

task_id

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认值:

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

job_id

否

String

参数解释:

执行记录ID，即每一次执行版本级或门禁级扫描的唯一ID。通过执行检查任务接口的返回值可获取执行记录ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认值:

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

operator

否

String

参数解释:

操作者。

约束限制:

不涉及。

取值范围:

不涉及。

默认值:

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

httpStatus

String

参数解释：

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

取值范围：

  • OK，接口响应成功。

  • ACCEPTED，接口响应成功。

  • INTERNAL_SERVER_ERROR，接口内部异常。

  • BAD_REQUEST，参数校验异常。

result

String

参数解释:

取消检查的结果，接口调用成功时返回"取消执行成功"。

取值范围:

取消执行成功。

status

String

参数解释：

接口响应状态。

取值范围：

  • success，接口响应成功。

  • error，接口响应失败。

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

取消执行任务ID为897acf5exxx48a5013cd且执行ID为ffd8exxxxxx8695d39的代码检查任务。

PUT https://{endpoint}/v1/tasks/897acf5exxx48a5013cd/stop?job_id=ffd8exxxxxx8695d39

响应示例

状态码：200

Request succeeded!

{
  "httpStatus" : "OK",
  "result" : "取消执行成功",
  "status" : "success"
}

状态码：400

Bad Request

{
  "error_code" : "CC.00000000",
  "error_msg" : "网络繁忙，请稍后再试"
}

状态码：401

Unauthorized

{
  "error_code" : "CC.00000003",
  "error_msg" : "认证信息过期"
}

状态码

状态码

描述

200

Request succeeded!

400

Bad Request

401

Unauthorized

错误码

请参见错误码。

父主题： 任务管理

相关文档