根据任务ID查询任务执行记录 - getJobsInfo
功能介绍
根据任务ID查询任务执行记录。
调用方法
请参见如何调用API。
授权信息
当前API调用无需身份策略权限。
URI
GET /v4/tasks/{task_id}/jobs
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
task_id |
是 |
String |
参数解释: 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
statuses |
否 |
Array of strings |
参数解释: 任务执行状态。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
|
begin_start_time |
否 |
String |
参数解释: 检查开始时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
end_start_time |
否 |
String |
参数解释: 检查结束时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
page |
否 |
Integer |
参数解释: 分页页码。 约束限制: 不涉及。 取值范围: ≥1。 默认取值: 不涉及。 |
|
page_size |
否 |
Integer |
参数解释: 分页大小。 约束限制: 不涉及。 取值范围:
默认取值: 10。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
|
Content-Type |
否 |
String |
参数解释: 媒体类型和编码格式。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: application/json;charset=UTF-8。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
Array of SimpleJobInfoV4 objects |
参数解释: 执行记录列表。 取值范围: 不涉及。 |
|
total |
Integer |
参数解释: 执行记录总数。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
subJobIds |
Array of strings |
参数解释: 子任务id。 取值范围: 不涉及。 |
|
finishTime |
String |
参数解释: 结束时间。 取值范围: 不涉及。 |
|
subJobStatuses |
Array of strings |
参数解释: 子任务状态。 取值范围: 不涉及。 |
|
reviewResult |
String |
参数解释: 门禁结果。 取值范围:
|
|
branchName |
String |
参数解释: 分支名称。 取值范围: 不涉及。 |
|
source |
String |
参数解释: 任务来源。 取值范围: 不涉及。 |
|
ruleSets |
Array of strings |
参数解释: 规则集。 取值范围: 不涉及。 |
|
executor |
String |
参数解释: 执行者。 取值范围: 不涉及。 |
|
startTime |
String |
参数解释: 开始时间。 取值范围: 不涉及。 |
|
id |
String |
参数解释: 执行ID,来自代码检查执行任务接口的返回值,每次执行代码检查任务都有1个唯一的执行ID。 取值范围: 不涉及。 |
|
jobType |
String |
参数解释: 任务类型。 取值范围:
|
|
taskId |
String |
参数解释: 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID。 取值范围: 不涉及。 |
|
status |
String |
参数解释: 任务执行状态。 取值范围:
|
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
查询任务ID为a746dcxxxxxxxxxxxxxxx4339d7代码检查任务的执行记录
GET https://{endpoint}/v4/tasks/a746dcxxxxxxxxxxxxxxx4339d7/jobs
响应示例
状态码:200
Request succeeded!
{
"data" : [ {
"subJobIds" : [ ],
"finishTime" : "2025-01-24T03:16:49Z",
"subJobStatuses" : [ ],
"reviewResult" : "success",
"branchName" : "master",
"source" : "customer",
"ruleSets" : [ ],
"executor" : "devcloud_codecheck_l00493925_01",
"startTime" : "2025-01-24T03:12:44Z",
"id" : "07xxxxxxxxxxxxxxxxxxxxxxxxxxxxx29",
"jobType" : "FULL",
"taskId" : "d1xxxxxxxxxxxxxxxxxxxxxxxxxxxe",
"status" : "success"
}, {
"subJobIds" : [ ],
"finishTime" : "2024-11-01T07:59:28Z",
"subJobStatuses" : [ ],
"reviewResult" : "success",
"branchName" : "master",
"source" : "customer",
"ruleSets" : [ ],
"executor" : "P_codecheck001",
"startTime" : "2024-11-01T07:58:31Z",
"id" : "84xxxxxxxxxxxxxxxxxxxxxxxxxxxx6f",
"jobType" : "FULL",
"taskId" : "d1xxxxxxxxxxxxxxxxxxxxxxxxxxxe",
"status" : "failed"
} ],
"total" : 2
}
状态码: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 |
错误码
请参见错误码。