文档首页> 代码托管 CodeArts Repo> API参考> API> Repository> 查询某仓库对应的分支
更新时间：2023-04-07 GMT+08:00
查看PDF
分享

查询某仓库对应的分支

功能介绍

根据仓库id获取指定仓库的分支列表.

调试

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

URI

GET /v1/repositories/{repository_id}/branches

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

是

String

仓库的主键id

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

error

Error object

响应错误

result

BranchList object

响应结果

status

String

响应状态
表4 Error

参数

参数类型

描述

code

String

错误码

message

String

错误信息
表5 BranchList

参数

参数类型

描述

branches

Array of Branch objects

指定仓库的分支列表

total

Integer

指定仓库的分支总数
表6 Branch

参数

参数类型

描述

is_protected

Boolean

是否开启保护分支功能

name

String

分支名

请求示例

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

响应示例

状态码： 200

OK

{
  "result" : {
    "total" : 1,
    "branches" : [ {
      "name" : "master",
      "is_protected" : false
    } ]
  },
  "status" : "success"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： Repository
分享：

    相关文档

    相关产品