文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ Branch/ 获取分支详情
更新时间：2025-07-15 GMT+08:00
查看PDF
分享

获取分支详情

功能介绍

获取分支详情

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

是

Integer

参数解释：

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

约束限制：

不涉及。

取值范围：

1-2147483647
表2 Query参数

参数

是否必选

参数类型

描述

branch_name

是

String

参数解释：

分支名称。

取值范围：

字符串长度不少于1，不超过2000。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

必传。

取值范围：

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

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Header参数

参数

参数类型

描述

X-Total

Integer

获取分支详情
表5 响应Body参数

参数

参数类型

描述

name

String

分支名

commit

CommitDto object

commit相关信息

merged

Boolean

用户id

protected

Boolean

是否为保护分支

developers_can_push

Boolean

开发者是否可以推送

developers_can_merge

Boolean

开发者是否可以合并

can_push

Boolean

是否可以推送

default

Boolean

是否为默认分支
表6 CommitDto

参数

参数类型

描述

id

String

id

message

String

消息

parent_ids

Array of strings

父节点提交ID

authored_date

String

创建该分支的时间

author_name

String

创建者名称

author_email

String

创建者邮箱

committed_date

String

代码提交的日期和时间

committer_name

String

提交者名称

committer_email

String

提交者邮箱

open_gpg_verified

Boolean

是否打开gpg校验

verification_status

Integer

验证状态

取值范围：

0-1

gpg_primary_key_id

String

GPG公钥的标识符

name

String

用户名

gpg_nick_name

String

昵称

gpg_tenant_name

String

租户名

gpg_user_name

String

特定GPG用户相关的信息

short_id

String

短id

created_at

String

创建时间

title

String

标题

author_avatar_url

String

author_avatar_url

committer_avatar_url

String

committer_avatar_url

relate_url

Array of RelatedCommitSimpleDto objects

only for DevCloud

nick_name

String

标题

tenant_name

String

tenant_name

user_name

String

用户名
表7 RelatedCommitSimpleDto

参数

参数类型

描述

related_id

String

关联工作项ID

related_url

String

关联工作URL

状态码：401

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

状态码：403

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

状态码：404

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

请求示例

GET https://{endpoint}/v4/repositories/2112015538/repository/branch?branch_name=master

响应示例

状态码：200

获取分支详情

{
  "name" : "12312312",
  "commit" : {
    "id" : "3e133ffd60e795ce52e092db03ebcc8da43ab471",
    "message" : "新建文件 ****",
    "parent_ids" : [ "****" ],
    "authored_date" : "2025-02-22T03:11:03.000Z",
    "author_name" : "****",
    "author_email" : "****",
    "committed_date" : "2025-02-22T03:11:03.000Z",
    "committer_name" : "****",
    "committer_email" : "****",
    "short_id" : "****",
    "created_at" : "2025-02-22T03:11:03.000Z",
    "title" : "新建文件 123123",
    "author_avatar_url" : "",
    "committer_avatar_url" : ""
  },
  "merged" : false,
  "protected" : true,
  "developers_can_push" : true,
  "developers_can_merge" : true,
  "can_push" : true,
  "default" : false
}

状态码：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

错误码

请参见错误码。

父主题： Branch

相关文档