获取分支列表
功能介绍
获取分支列表
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/branches
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目ID，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID。 最小长度：32 最大长度：32 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
sort_field |
否 |
String |
排序字段 枚举值：
|
sort_type |
否 |
String |
排序方式 枚举值：
|
offset |
是 |
Integer |
起始偏移量，表示从此偏移量开始查询， offset大于等于0，小于等于20000 最小值：0 最大值：20000 |
limit |
是 |
Integer |
每页显示的条目数量，最大支持200条 最小值：1 最大值：200 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：100000 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
total |
Integer |
起始记录数 大于 实际总条数时， 值为0， 分页请求才有此值 |
project_id |
String |
项目ID |
values |
Array of ExternalBranchInfoVo objects |
实际的数据类型：单个对象，集合 或 NULL |
参数 |
参数类型 |
描述 |
|---|---|---|
id |
String |
分支ID |
type |
String |
类型 |
author |
String |
创建人 |
name |
String |
名称 |
region |
String |
区域 |
last_modifier |
String |
最后修改人 |
last_modified |
String |
最后修改时间 |
last_modified_timestamp |
Long |
修改时间时间戳 |
creation_date |
String |
创建时间 |
creation_date_timestamp |
Long |
创建时间时间戳 |
author_name |
String |
创建人名称 |
is_base_branch |
Integer |
是否为基线分支。0表示不是基线分支，1表示是基线分支。 |
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
接口调用失败错误码 |
error_msg |
String |
接口调用失败错误信息 |
状态码： 401
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
接口调用失败错误码 |
error_msg |
String |
接口调用失败错误信息 |
状态码： 404
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
接口调用失败错误码 |
error_msg |
String |
接口调用失败错误信息 |
状态码： 500
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
接口调用失败错误码 |
error_msg |
String |
接口调用失败错误信息 |
请求示例
get https://{endpoint}/v1/efdb403066474ab08836b9eeaaa23bca/branches?offset=1&limit=10&sort_field=name&sort_type=ASC
响应示例
状态码： 200
OK
{
"total" : 1,
"project_id" : "1f22e3511dd348e38131b4066afbd0b4",
"values" : [ {
"id" : "001s16gt6q5",
"type" : "TestVersion",
"author" : "efdb403066474ab08836b9eeaaa23bca",
"name" : "名称",
"region" : "cn-north-7",
"last_modifier" : "张三",
"last_modified" : "2023-07-20 02:17:01",
"last_modified_timestamp" : 1660617231016,
"creation_date" : "2023-07-20 02:17:01",
"creation_date_timestamp" : 1660617231016,
"author_name" : "tester",
"is_base_branch" : 0
} ]
}
状态码
状态码 |
描述 |
|---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
404 |
Not Found |
500 |
Internal Server Error |
错误码
请参见错误码。
