更新时间:2025-07-15 GMT+08:00
分享

获取分支列表

功能介绍

获取分支列表

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v4/repositories/{repository_id}/repository/branches

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

Integer

参数解释:

仓库的ID,通过查询用户所有仓库接口查询项目列表获取。

约束限制:

不涉及。

取值范围:

1-2147483647

表2 Query参数

参数

是否必选

参数类型

描述

branch_type

String

参数解释:

分支类型,默认返回全部分支,not_protect,返回非保护分支。

约束限制:

不涉及。

取值范围:

不涉及。

枚举值:

  • not_protect

creator

String

参数解释:

创建者,用户ID或者IamId。

取值范围:

字符串长度不少于1,不超过100000。

sort

String

参数解释:

排序方式

约束限制:

  • name,分支名倒序。

  • updated_desc,更新时间倒序。

  • updated_asc,更新时间正序。

默认取值:

updated_desc

枚举值:

  • name

  • updated_desc

  • updated_asc

query_view

String

参数解释:

分支类型

约束限制:

  • my_branches,个人分支。

  • active,活跃分支。

  • stale,过时分支。

  • all_branches,所有分支。

默认取值:

all_branches

枚举值:

  • my_branches

  • active

  • stale

  • all_branches

view

String

参数解释:

结果集属性,根据给定的参数返回不同的结果

约束限制:

  • all,返回分支的所有信息。

  • basic,返回分支的基本信息。

  • simple,返回分支的简单信息。

枚举值:

  • simple

  • basic

  • all

offset

Integer

参数解释:

偏移量,从0开始。

取值范围:

0-2147483647

默认取值:

0

limit

Integer

参数解释:

返回数量。

取值范围:

1-100

默认取值:

20

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

必传。

取值范围:

字符串长度不少于1,不超过10万。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Header参数

参数

参数类型

描述

X-Total

Integer

参数解释:

分支总数。

表5 响应Body参数

参数

参数类型

描述

[数组元素]

Array of BranchSimpleDto objects

分支列表

表6 BranchSimpleDto

参数

参数类型

描述

name

String

分支名称

取值范围:

1-100000

default

Boolean

是否为默认分支

can_delete

Boolean

用户是否为默认分支

can_read

Boolean

是否为默认分支

can_download

Boolean

是否为默认分支

can_push

Boolean

是否为默认分支

状态码:401

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

状态码:403

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

状态码:404

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

请求示例

GET https://{endpoint}/v4/repositories/2112015538/repository/branches

响应示例

状态码:200

分支列表

[ {
  "name" : "master",
  "default" : true,
  "can_delete" : null,
  "can_read" : null,
  "can_download" : null,
  "can_push" : null
} ]

状态码:401

Unauthorized

{
  "error_code" : "CH.00000001",
  "error_msg" : "未识别到用户认证信息"
}

状态码:403

Bad Request

{
  "error_code" : "CH.00401008",
  "error_msg" : "您没有操作权限,请升级权限后重试。"
}

状态码:404

Not Found

{
  "error_code" : "CH.00402000",
  "error_msg" : "该仓库不存在,请检查后重试。"
}

状态码

状态码

描述

200

分支列表

401

Unauthorized

403

Bad Request

404

Not Found

错误码

请参见错误码

相关文档