更新时间:2025-08-25 GMT+08:00
分享

执行检查任务

功能介绍

执行检查任务。

调用方法

请参见如何调用API

URI

POST /v2/tasks/{task_id}/run

表1 路径参数

参数

是否必选

参数类型

描述

task_id

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目的32位uuid,项目唯一标识,通过查询项目列表接口查询项目列表获取。

约束限制:

不涉及。

取值范围:

32位项目ID。

默认取值:

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及。

取值范围:

字符串长度不少于1,不超过10万。

默认取值:

不涉及。

X-Language

String

参数解释:

语言,决定响应以哪种语言返回。

约束限制:

不涉及。

取值范围:

  • zh-cn,中文。

  • en-us,英文。

默认取值:

zh-cn

表4 请求Body参数

参数

是否必选

参数类型

描述

username

String

废弃参数。

access_token

String

废弃参数。

git_url

String

废弃参数。

git_branch

String

废弃参数。

ref

String

参数解释:

代码仓拉取mr代码的方式,推荐在检查阶段拉取mr代码失败时使用此参数进行拉取方式的指定。

约束限制:

不涉及。

取值范围:

  • pull:以pull/xx/xx方式进行拉取。

  • merge_request:以merge_request/xx/xx方式进行拉取。

默认取值:

不传时,后台自动识别代码仓类型以进行mr代码的拉取,gitee仓以pull/xx/xx方式进行拉取,非gitee仓以merge_request/xx/xx方式进行拉取。

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

exec_id

String

参数解释:

1次代码检查对应的执行记录id。

取值范围:

32位UUID。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

执行检查任务:如需自行指定增量代码下载方式,则传递参数ref

POST https://{endpoint}/v2/tasks/{task_id}/run

{
  "ref" : "merge_request"
}

响应示例

状态码:200

Request succeeded!

{
  "exec_id" : "d163535d0*******81d6a7654443e"
}

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

错误码

请参见错误码

相关文档