删除任务 - DeleteTaskV3
功能介绍
根据任务ID彻底删除代码检查任务，删除后任务的配置项、缺陷数据、执行记录等信息不能恢复。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型（*为必须） | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| codeartscheck:task:delete | Write | task * | - | - | - |
| - | codeartscheck:ProjectId |
URI
DELETE /v3/task/{task_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| task_id | 是 | String | 参数解释： 任务ID，即新建检查任务接口的返回值，每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即查询任务列表接口响应中的id字段。 约束限制： 不涉及。 取值范围： 长度为[1~32]个字符。 默认取值： 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释： 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制： 不涉及。 取值范围： 长度为[1~100000]的字符。 默认取值： 不涉及。 |
| operator | 否 | String | 参数解释： 操作者。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| httpStatus | String | 参数解释： HTTP响应状态。 取值范围： |
| result | String | 参数解释： 删除成功时，result字段为"true"。 取值范围： 不涉及。 |
| status | String | 参数解释： 接口响应状态。 取值范围： |
状态码：400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释： 错误码。 取值范围： 不涉及。 |
| error_msg | String | 参数解释： 错误描述。 取值范围： 不涉及。 |
状态码：401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释： 错误码。 取值范围： 不涉及。 |
| error_msg | String | 参数解释： 错误描述。 取值范围： 不涉及。 |
请求示例
删除任务ID为897acf5exxx48a5013cd的代码检查任务。
DELETE https://{endpoint}/v3/task/897acf5exxx48a5013cd 响应示例
状态码：200
删除任务成功
{
"httpStatus" : "OK",
"result" : true,
"status" : "success"
} 状态码：400
请求异常。
{
"error_code" : "CC.xxxxxxxx.400",
"error_msg" : "请求参数校验失败,请检查请求参数是否正确"
} 状态码：401
权限不足。
{
"error_code" : "CC.00000003",
"error_msg" : "认证信息过期"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 删除任务成功 |
| 400 | 请求异常。 |
| 401 | 权限不足。 |
错误码
请参见错误码。
