获取任务分支列表
功能介绍
获取任务分支列表。
调用方法
请参见如何调用API。
URI
GET /v4/tasks/{task_id}/branches
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
task_id |
是 |
String |
参数解释: 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
is_uncreated_only |
否 |
String |
参数解释: 是否只查询未创建分支任务的分支。 约束限制: 不涉及。 取值范围:
默认取值: false。 |
|
page |
否 |
Integer |
参数解释: 分页页码。 取值范围: 分页页码>=1。 取值范围:
默认取值: 不涉及。 |
|
page_size |
否 |
Integer |
参数解释: 分页大小。 取值范围: 数字1-200之间。 取值范围:
默认取值: 不涉及。 |
|
search |
否 |
String |
参数解释: 搜索的分支名。 约束限制: 不涉及。 取值范围: 字符串长度不超过128。 默认取值: 不涉及。 |
|
repo_type |
否 |
String |
参数解释: 代码仓类型。 约束限制: 不涉及。 取值范围: gitcode、gitlab、GitPub、Gitee、DevCloud。 默认取值: 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码: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.00000000",
"error_msg" : "网络繁忙,请稍后再试"
}
状态码:401
Unauthorized
{
"error_code" : "CC.00000003",
"error_msg" : "认证信息过期"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Request succeeded! |
|
400 |
Bad Request |
|
401 |
Unauthorized |
错误码
请参见错误码。