# 查询分支任务列表 - ShowBranchTasks #### 功能介绍 根据项目ID、任务ID和任务类型分页查询任务列表，可通过此接口查询任务下的分支任务、Tag任务、Mr任务和Commit任务。 #### 调用方法 请参见[如何调用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 /v3/{project_id}/tasks/{task_id}/branches 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 兼容历史版本的废弃参数，不校验真实性。项目的32位UUID，项目唯一标识，通过[查询项目列表](https://support.huaweicloud.com/api-projectman/ListProjectsV4.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 32位项目ID。 **默认取值：** 不涉及。 | | task_id | 是 | String | **参数解释：** 任务ID，即新建检查任务接口的返回值，每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即[查询任务列表](https://support.huaweicloud.com/api-codecheck/ShowTasksList.html)接口响应中的id字段。 **约束限制：** 不涉及。 **取值范围：** 长度为\[1\~32\]个字符。 **默认取值：** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | page_num | 否 | Integer | **参数解释：** 分页索引。 **约束限制：** 不涉及。 **取值范围：** 1-2147483647 **默认取值：** 1 | | page_size | 否 | Integer | **参数解释：** 每页显示的数量。 **约束限制：** 不涉及。 **取值范围：** 1-100 **默认取值：** 10 | | check_type | 否 | String | **参数解释：** 任务类型。 **约束限制：** 不涉及。 **取值范围：** - branch：分支。 - tag：Tag。 - mr：Merge Request。 - cr：Change Request。 **默认取值：** branch。 | | offset | 否 | Integer | **参数解释：** 废弃参数，无业务意义，请勿使用。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | limit | 否 | Integer | **参数解释：** 废弃参数，无业务意义，请勿使用。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及。 **取值范围：** 长度为\[1\~100000\]的字符。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200 check_type: branch/tag** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | branchTasks | Array of [BranchTaskInfo] objects | **参数解释：** task_id对应任务下已创建的分支、Tag任务信息。 | | total | Integer | **参数解释：** 总数。 **取值范围：** ≥0 | 表5BranchTaskInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | taskId | String | **参数解释：** 任务ID，即新建检查任务接口的返回值，每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即[查询任务列表](https://support.huaweicloud.com/api-codecheck/ShowTasksList.html)接口响应中的id字段。 **取值范围：** 长度为\[1\~32\]个字符。 | | branchName | String | **参数解释：** 分支名。 **取值范围：** 不涉及。 | | isDefault | String | **参数解释：** 是否为默认分支。 **取值范围：** - true：默认分支。 - false：非默认分支。 | | status | String | **参数解释:** 最近一次代码检查任务执行状态。 **取值范围:** - quering：初始状态。 - running：执行中。 - success：检查成功。 - failed：检查失败。 - aborted：任务中止。 - null：未检查。 | **状态码：200 check_type: mr/cr** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | incTasks | Array of [IncTaskInfo] objects | **参数解释:** task_id对应任务下已创建的mr、cr任务信息。 | | total | Integer | **参数解释：** 总数。 **取值范围：** ≥0 | 表7IncTaskInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | taskId | String | **参数解释：** 任务ID，即新建检查任务接口的返回值，每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即[查询任务列表](https://support.huaweicloud.com/api-codecheck/ShowTasksList.html)接口响应中的id字段。 **取值范围：** 长度为\[1\~32\]个字符。 | | mergeId | String | **参数解释：** MR查询下为MR编号，CR查询下为Git Commit ID。 **取值范围：** 不涉及。 | | jobType | String | **参数解释：** 任务类型。 **取值范围：** - FULL：版本级任务。 - INC_GIT：门禁级任务。 - INC_COMMIT：流水线指定commitId增量检查、代码检查任务设置-检查范围-版本级检查模式的最近一次提交检查。 - INC_LAST_SUCCESS_COMMIT：流水线指定commitId以及最后一次门禁成功的commitId间的增量检查。 | | status | String | **参数解释:** 任务执行状态。 **取值范围:** - quering：初始状态。 - running：执行中。 - success：检查成功。 - failed：检查失败。 - aborted：任务中止。 | | startTime | String | **参数解释:** 检查开始时间，UTC格式，格式为yyyy-MM-ddTHH:mm:ssZ，例如"2025-11-28T06:55:41Z"。 **取值范围:** 不涉及。 | | finishTime | String | **参数解释:** 检查结束时间，UTC格式，格式为yyyy-MM-ddTHH:mm:ssZ，例如"2025-11-28T06:55:41Z"。 **取值范围:** 不涉及。 | | mergeInfo | String | **参数解释:** MR信息 **取值范围:** 不涉及。 | | jobId | String | **参数解释:** 执行记录ID，即每一次执行版本级或门禁级扫描的唯一ID。通过[执行检查任务](https://support.huaweicloud.com/api-codecheck/RunTaskV2.html)接口的返回值可获取执行记录ID。 **取值范围:** 不涉及。 | **状态码：400** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | **状态码：401** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | #### 请求示例 查询task_id对应任务下已创建的分支任务信息。 ``` GET https://{endpoint}/v3/{project_id}/tasks/{task_id}/branches ``` #### 响应示例 **状态码：200 check_type: branch/tag** 请求成功! ``` { "branchTasks" : [ { "taskId" : "11223344xxxxxxxx11223344xxxxxxx1", "branchName" : "dev01", "isDefault" : "false", "status" : "failed" }, { "taskId" : "11223344xxxxxxxx11223344xxxxxxx2", "branchName" : "master", "isDefault" : "true", "status" : "success" } ], "total" : 6 } ``` **状态码：200 check_type: mr/cr** 请求成功! ``` { "incTasks" : [ { "taskId" : "e6f59xxxx4fc46bcabfxxxxfa502fe56", "mergeId" : "2", "jobType" : "INC_GIT", "status" : "success", "startTime" : "2025-01-15T12:23:51Z", "finishTime" : "2025-01-15T12:25:06Z", "mergeInfo" : "test", "jobId" : "49e3bbxxxx8842819da744d9xxxx8478" } ], "total" : 23 } ``` **状态码：400** 请求异常。 ``` { "error_code" : "CC.xxxxxxxx.400", "error_msg" : "请求参数校验失败,请检查请求参数是否正确" } ``` **状态码：401** 权限不足。 ``` { "error_code" : "CC.00000003", "error_msg" : "认证信息过期" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 check_type: branch/tag | 请求成功! | | 200 check_type: mr/cr | 请求成功! | | 400 | 请求异常。 | | 401 | 权限不足。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-codecheck/ErrorCode.html)。