文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ v2仓库管理/ 创建分支
更新时间：2024-11-08 GMT+08:00
查看PDF
分享

创建分支

功能介绍

根据仓库id在指定仓库中创建分支

调试

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

URI

POST /v2/repositories/{repository_id}/branches

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

是

String

参数解释：

仓库短ID。

约束限制：

必传。

取值范围：

只能由数字组成，数字可取范围为0-2147483647。

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

必传。

取值范围：

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

默认取值：

不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

branch_name

是

String

参数解释：

分支名称

约束限制：

必传

取值范围：

最小长度：1

最大长度：200

默认取值：

不涉及

ref

是

String

参数解释：

源分支名称

约束限制：

必传

取值范围：

最小长度：1

最大长度：200

默认取值：

不涉及

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

error

Error object

参数解释：

响应错误码

result

AddProtectResponse object

参数解释：

响应结果

status

String

参数解释：

调用此接口的响应状态。

取值范围：

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

参数

参数类型

描述

code

String

参数解释：

错误码

取值范围：

符合错误码格式字符串，长度[0,100]

message

String

参数解释：

错误信息

取值范围：

不涉及
表6 AddProtectResponse

参数

参数类型

描述

name

String

参数解释：

分支名称

commit

CommitRepoV2 object

参数解释：

提交信息

protected

Boolean

参数解释：

是否保护

developers_can_push

Boolean

参数解释：

是否允许开发者提交

developers_can_merge

Boolean

参数解释：

是否允许开发者合并

master_can_push

Boolean

参数解释：

是否允许管理员提交

master_can_merge

Boolean

参数解释：

是否允许管理员合并

no_one_can_push

Boolean

参数解释：

没有人允许提交

no_one_can_merge

Boolean

参数解释：

没有人允许合并

in_an_opened_merge_request

Boolean

参数解释：

是否在一个打开的合并请求
表7 CommitRepoV2

参数

参数类型

描述

id

String

参数解释：

提交对应的SHA id

short_id

String

参数解释：

提交对应的短SHA id

created_at

String

参数解释：

创建时间

title

String

参数解释：

提交标题

parent_ids

Array of strings

参数解释：

父提交id

message

String

参数解释：

提交信息

author_name

String

参数解释：

作者

committer_name

String

参数解释：

提交作者

committed_date

String

参数解释：

提交时间

请求示例

{
  "ref" : "master",
  "branch_name" : "test"
}

响应示例

状态码： 200

OK

{
  "result" : {
    "name" : "master",
    "commit" : {
      "id" : "3b68902cf0eb7de3d5c8757e4a990bc3fe0af349",
      "short_id" : "3b68902c",
      "title" : "新建文件",
      "created_at" : "2022-03-08T03:14:39.000Z",
      "parent_ids" : [ "08618c900a4048aae7e4cd88913d3d521eae02eb" ],
      "message" : "新建文件",
      "author_name" : "repo",
      "committer_name" : "repo",
      "committed_date" : "2022-03-08T03:14:39.000Z"
    },
    "protected" : true,
    "developers_can_push" : false,
    "developers_can_merge" : false,
    "master_can_push" : false,
    "master_can_merge" : false,
    "no_one_can_push" : true,
    "no_one_can_merge" : true,
    "in_an_opened_merge_request" : false
  },
  "status" : "success"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： v2仓库管理

相关文档