# 根据任务ID查询任务执行记录 - getJobsInfo #### 功能介绍 当任务的执行记录比较多时，用户可根据任务ID、执行时间和任务执行状态分页查询任务下的执行记录。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-codecheck/codecheck_03_0006.html)。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-codecheck/Permission.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | codeartscheck:task:get | Read | task \* | - | - | - | | codeartscheck:task:get | Read | - | codeartscheck:ProjectId | - | - | #### URI GET /v4/tasks/{task_id}/jobs 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | task_id | 是 | String | **参数解释：** 任务ID，即新建检查任务接口的返回值，每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即[查询任务列表](https://support.huaweicloud.com/api-codecheck/ShowTasksList.html)接口响应中的id字段。 **约束限制：** 不涉及。 **取值范围：** 长度为\[1\~32\]个字符。 **默认取值：** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及。 **取值范围：** 长度为\[1\~100000\]的字符。 **默认取值：** 不涉及。 | | Content-Type | 否 | String | **参数解释：** 媒体类型和编码格式。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** application/json;charset=UTF-8。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data | Array of [SimpleJobInfoV4] objects | **参数解释：** 执行记录列表。 **取值范围：** 不涉及。 | | total | Integer | **参数解释：** 执行记录总数。 **取值范围：** 不涉及。 | 表5SimpleJobInfoV4 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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。即[查询任务列表](https://support.huaweicloud.com/api-codecheck/ShowTasksList.html)接口响应中的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** 请求成功! ``` { "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** 请求异常。 ``` { "error_code" : "CC.xxxxxxxx.400", "error_msg" : "请求参数校验失败,请检查请求参数是否正确" } ``` **状态码：401** 权限不足。 ``` { "error_code" : "CC.00000003", "error_msg" : "认证信息过期" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功! | | 400 | 请求异常。 | | 401 | 权限不足。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-codecheck/ErrorCode.html)。