更新时间：2025-04-27 GMT+08:00
执行检查任务
功能介绍
执行检查任务。
调用方法
请参见如何调用API。
URI
POST /v2/tasks/{task_id}/run
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
task_id |
是 |
String |
任务ID，即新建检查任务接口的返回值，每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
Content-Type |
是 |
String |
设置媒体类型和编码格式 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
username |
否 |
String |
该任务对应临时仓库有权限的用户名，参数计划下线，不建议使用 |
|
access_token |
否 |
String |
该任务对应临时仓库有权限的用户token，参数计划下线，不建议使用 |
|
git_url |
否 |
String |
该任务对应的临时仓库地址，参数计划下线，不建议使用 |
|
git_branch |
否 |
String |
该任务对应的临时仓库分支，参数计划下线，不建议使用 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
exec_id |
String |
执行id |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
执行检查任务:执行任务对应代码仓URL根据实际显示，代码仓分支为master，用户名根据实际显示
POST https://{endpoint}/v2/tasks/{taskid}/run
{
"git_url" : "http://github.xxxxxxxx.git",
"git_branch" : "master",
"username" : "test",
"access_token" : "xLD56xxxxxxxxxJF3Sdxxxx"
}
响应示例
状态码：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 |
错误码
请参见错误码。
