查询任务分支列表 - ListPortalServiceRepositoryBranches
功能介绍
根据任务ID、需要搜索的分支名分页查询任务下的分支列表。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
codeartscheck:task:get | Read | task * | - | - | - |
- | codeartscheck:ProjectId |
URI
GET /v4/tasks/{task_id}/branches
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
task_id | 是 | String | 参数解释: 任务ID,即新建检查任务接口的返回值,每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即查询任务列表接口响应中的id字段。 约束限制: 不涉及。 取值范围: 长度为[1~128]个字符。 默认取值: 不涉及。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
is_uncreated_only | 否 | String | 参数解释: 是否只查询未创建分支任务的分支。 约束限制: 不涉及。 取值范围:
默认取值: false。 |
page | 否 | Integer | 参数解释: 分页页码。 约束限制: 分页页码≥1。 取值范围: 1-2147483647 默认取值: 不涉及。 |
page_size | 否 | Integer | 参数解释: 分页大小。 约束限制: 数字1-200之间。 取值范围: 1-200 默认取值: 不涉及。 |
search | 否 | String | 参数解释: 搜索的分支名。 约束限制: 不涉及。 取值范围: 字符串长度不超过128。 默认取值: 不涉及。 |
repo_type | 否 | String | 参数解释: 代码仓类型。 约束限制: 不涉及。 取值范围: gitcode、gitlab、GitPub、Gitee、DevCloud。 默认取值: 不涉及。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 长度为[1~100000]个字符。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
branch_list | Array of strings | 参数解释: 分支名列表。 取值范围: 分支名列表个数不超过200个。 |
total | Integer | 参数解释: 分支总数。 取值范围: ≥0 |
状态码:400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
error_msg | String | 参数解释: 错误描述。 取值范围: 不涉及。 |
状态码:401
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
error_msg | String | 参数解释: 错误描述。 取值范围: 不涉及。 |
请求示例
查询ID为897acf5exxx48a5013cd的任务的分支名包含test01且未创建分支任务的分支列表,分页为第一页,分页大小为20。
GET https://{endpoint}/v4/tasks/897acf5exxx48a5013cd/branches?is_uncreated_only=true&search=test01&page=1&page_size=20 响应示例
状态码:200
Request succeeded!
{
"data" : [ "dev", "master" ],
"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 |
错误码
请参见错误码。

