文档首页/ 代码检查 CodeArts Check/ API参考/ API/ 任务管理/ 根据任务ID查询任务执行记录 - getJobsInfo
更新时间:2025-12-30 GMT+08:00
分享

根据任务ID查询任务执行记录 - getJobsInfo

功能介绍

当任务的执行记录比较多时,用户可根据任务ID、执行时间和任务执行状态分页查询任务下的执行记录。

调用方法

请参见如何调用API

授权信息

账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

codeartscheck:task:get

Read

task *

-

-

-

-

codeartscheck:ProjectId

URI

GET /v4/tasks/{task_id}/jobs

表1 路径参数

参数

是否必选

参数类型

描述

task_id

String

参数解释:

任务ID,即新建检查任务接口的返回值,每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即查询任务列表接口响应中的id字段。

约束限制:

不涉及。

取值范围:

长度为[1~128]个字符。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

statuses

Array of strings

参数解释:

任务执行状态。

约束限制:

不涉及。

取值范围:

  • quering:初始状态。

  • running:执行中。

  • success:检查成功。

  • failed:检查失败。

  • aborted:任务中止。

默认取值:

不涉及。

begin_start_time

String

参数解释:

检查开始时间。

约束限制:

不涉及。

取值范围:

使用UTC时间,格式为yyyy-MM-ddTHH:mm:ssZ。例如:2020-09-25T12:05:00Z。

默认取值:

不涉及。

end_start_time

String

参数解释:

检查结束时间。

约束限制:

不涉及。

取值范围:

使用UTC时间,格式为yyyy-MM-ddTHH:mm:ssZ。例如:2020-09-25T12:05:00Z。

默认取值:

不涉及。

page

Integer

参数解释:

分页页码。

约束限制:

不涉及。

取值范围:

≥1

默认取值:

1

page_size

Integer

参数解释:

分页大小。

约束限制:

不涉及。

取值范围:

1-200

默认取值:

200

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及。

取值范围:

长度为[1~100000]个字符。

默认取值:

不涉及。

Content-Type

String

参数解释:

媒体类型和编码格式。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

application/json;charset=UTF-8。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

data

Array of SimpleJobInfoV4 objects

参数解释:

执行记录列表。

取值范围:

不涉及。

total

Integer

参数解释:

执行记录总数。

取值范围:

不涉及。

表5 SimpleJobInfoV4

参数

参数类型

描述

subJobIds

Array of strings

参数解释:

子任务ID。

取值范围:

不涉及。

finishTime

String

参数解释:

结束时间。

取值范围:

不涉及。

subJobStatuses

Array of strings

参数解释:

子任务状态。

取值范围:

不涉及。

reviewResult

String

参数解释:

门禁结果。

取值范围:

  • success:门禁通过。

  • error:门禁不通过。

branchName

String

参数解释:

分支名称。

取值范围:

不涉及。

source

String

参数解释:

任务来源。

取值范围:

  • customer:来自页面点击。

  • Scheduled:来自定时任务。

  • CodeCheckEdge:来自Edge服务。

  • CodeArtsPipeline:来自流水线。

  • DevCloudWebhook:来自CodeArtsRepo的Webhook。

  • GitCodeActionPipeline:来自流水线的GitCodeAction插件。

ruleSets

Array of strings

参数解释:

规则集。

取值范围:

不涉及。

executor

String

参数解释:

执行者。

取值范围:

不涉及。

startTime

String

参数解释:

开始时间。

取值范围:

不涉及。

id

String

参数解释:

执行ID,来自代码检查执行任务接口的返回值,每次执行代码检查任务都有唯一的执行ID。

取值范围:

不涉及。

jobType

String

参数解释:

任务类型。

取值范围:

  • FULL:版本级任务。

  • INC_GIT:门禁级任务。

  • INC_COMMIT:流水线指定commitId增量检查。

  • INC_LAST_SUCCESS_COMMIT:流水线指定commitId以及最后一次门禁成功的commitId间的增量检查。

taskId

String

参数解释:

任务ID,即新建检查任务接口的返回值,每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即查询任务列表接口响应中的id字段。

取值范围:

不涉及。

status

String

参数解释:

任务执行状态。

取值范围:

  • quering:初始状态。

  • running:执行中。

  • success:检查成功。

  • failed:检查失败。

  • aborted:任务中止。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

error_msg

String

参数解释:

错误描述。

取值范围:

不涉及。

状态码:401

表7 响应Body参数

参数

参数类型

描述

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_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.xxxxxxxx.400",
  "error_msg" : "请求参数校验失败,请检查请求参数是否正确"
}

状态码:401

Unauthorized

{
  "error_code" : "CC.00000003",
  "error_msg" : "认证信息过期"
}

状态码

状态码

描述

200

Request succeeded!

400

Bad Request

401

Unauthorized

错误码

请参见错误码

相关文档