文档首页/ 代码托管 CodeArts Repo/ API参考/ 历史API/ Repository/ 获取仓库分支列表(废弃)
更新时间:2025-08-20 GMT+08:00
分享

获取仓库分支列表(废弃)

功能介绍

用户可通过此接口查询到有权限仓库的仓库分支列表。

当前API已经废弃,请使用获取分支列表

调试

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

URI

GET /v2/repositories/{repository_id}/branches

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

Integer

参数解释:

仓库ID,进入仓库的“代码”页面,仓库名称下的“Reposiotry ID”即为仓库ID。

约束限制:

不涉及。

取值范围:

0-2147483647

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

page

String

参数解释

页数,从1开始计数。

约束限制

不涉及。

取值范围

1-2147483647

默认取值:

1

per_page

String

参数解释

每页显示查询到的仓库分支数量。

约束限制

不涉及。

取值范围

1-100

默认取值:

20

match

String

匹配条件

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及。

取值范围:

字符串长度为[1100000]。

默认取值:

不涉及。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

error

Error object

参数解释:

响应错误码。

result

BranchResponse object

参数解释:

响应结果。

status

String

参数解释:

调用此接口的响应状态。

取值范围:

  • success,表示接口调用成功。
  • failed,表示接口调用失败。
表5 Error

参数

参数类型

描述

code

String

参数解释

错误码。

取值范围

请参见错误码

message

String

参数解释

错误信息。

表6 BranchResponse

参数

参数类型

描述

branches

Array of BranchesItem objects

参数解释

查询到的分支信息。

total

Double

参数解释

查询到的分支总数。

表7 BranchesItem

参数

参数类型

描述

commit

CommitV2 object

参数解释

提交信息。

diverging_commit_counts

DivergingCommitCounts object

参数解释

提交差异数量。

name

String

参数解释

分支名称。

表8 CommitV2

参数

参数类型

描述

committed_date

String

参数解释

提交时间,格式为:YYYY-MM-DDTHH:MM:SSZ。

例如,2025-07-19T12:34:56Z表示2025年7月19日12点34分56秒的UTC时间。

committer_name

String

参数解释:

提交者。

id

String

参数解释:

提交对应的SHA ID,即Git版本控制系统中用于唯一标识每个提交(commit)的40位十六进制字符串。

message

String

参数解释:

提交信息,包含提交的目的和内容。

short_id

String

参数解释:

提交对应的短SHA ID,即SHA ID的简写形式,通常是前几位,一般是7到10位。

title

String

参数解释:

用户在Git提交的标题。

表9 DivergingCommitCounts

参数

参数类型

描述

ahead

Double

参数解释:

领先提交数,表示一个分支比另一个分支多出的提交次数。

behind

Double

参数解释:

滞后提交数。如果一个分支没有包含另一个分支上的最新提交,那么这个分支就处于“滞后”状态,其中缺失的提交次数即为“滞后提交数”。

请求示例

GET https://{endpoint}/v2/repositories/{repository_id}/branches

响应示例

状态码: 200

OK

{
  "result" : {
    "total" : 1,
    "branches" : [ {
      "name" : "master",
      "commit" : {
        "id" : "2912b8f2328e798f7d544272ffaebfccccb598ab",
        "title" : "Initial commit",
        "message" : "Initial commit",
        "committed_date" : "2021-12-06T09:24:50.000+08:00",
        "short_id" : "2912b8f2",
        "committer_name" : "repo"
      },
      "diverging_commit_counts" : {
        "behind" : 0,
        "ahead" : 0
      }
    } ]
  },
  "status" : "success"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档