执行检查任务 - RunTaskV2
功能介绍
根据任务ID对任务所在的仓库和分支执行一次版本级扫描。
调用方法
请参见如何调用API。
授权信息
当前API调用无需身份策略权限。
URI
POST /v2/tasks/{task_id}/run
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
task_id |
是 |
String |
参数解释: 任务ID,即新建检查任务接口的返回值,每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即查询任务列表接口响应中的id字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 长度为[1~100000]个字符。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
username |
否 |
String |
参数解释: 废弃参数。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
access_token |
否 |
String |
参数解释: 废弃参数。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
git_url |
否 |
String |
参数解释: 废弃参数。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
git_branch |
否 |
String |
参数解释: 废弃参数。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
ref |
否 |
String |
参数解释: 代码仓拉取MR代码的方式,推荐在检查阶段拉取MR代码失败时使用此参数进行拉取方式的指定。 约束限制: 不涉及。 取值范围:
默认取值: 后台自动识别代码仓类型以进行MR代码的拉取。 gitee仓:以pull/xx/xx方式进行拉取。 非gitee仓:以merge_request/xx/xx方式进行拉取。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
exec_id |
String |
参数解释: 1次代码检查对应的执行记录ID。 取值范围: 32位UUID。 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码。 取值范围: 不涉及。 |
|
error_msg |
String |
参数解释: 错误描述。 取值范围: 不涉及。 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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.xxxxxxxx.400",
"error_msg" : "请求参数校验失败,请检查请求参数是否正确"
}
状态码:401
Unauthorized
{
"error_code" : "CC.00000003",
"error_msg" : "认证信息过期"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Request succeeded! |
|
400 |
Bad Request |
|
401 |
Unauthorized |
错误码
请参见错误码。