创建分支

repository_id

是

Integer

参数解释：

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

约束限制：

不涉及。

取值范围：

1-2147483647

X-Auth-Token

是

String

参数解释：

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

约束限制：

必传。

取值范围：

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

默认取值：

不涉及。

branch

是

String

参数解释：

分支名称。

约束限制：

不支持以 - . refs/heads/ refs/remotes/ 开头，不支持空格 [ \ < ~ ^ : ? * ! ( ) ' " | 等特殊字符，不支持以. / .lock结尾。

取值范围：

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

默认取值：

不涉及。

ref

是

String

参数解释：

基于分支名称。

约束限制：

不支持以 - . refs/heads/ refs/remotes/ 开头，不支持空格 [ \ < ~ ^ : ? * ! ( ) ' " | 等特殊字符，不支持以. / .lock结尾。

取值范围：

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

默认取值：

不涉及。

description

否

String

参数解释：

分支描述。

约束限制：

无。

取值范围：

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

默认取值：

不涉及。

related_ids

否

Array of strings

参数解释：

关联工作项列表。

约束限制：

无。

取值范围：

无。

默认取值：

不涉及。

name

String

分支名称

取值范围：

1-100000

default

Boolean

是否为默认分支

can_delete

Boolean

用户是否为默认分支

can_read

Boolean

是否为默认分支

can_download

Boolean

是否为默认分支

can_push

Boolean

是否为默认分支

commit

CommitDto object

commit相关信息

merged

Boolean

所有提交是否合入到默认分支

protected

Boolean

是否为保护分支

created_at

String

创建时间

creator

UserBasicDto object

用户信息

description

String

分支描述

create_source

String

基于分支

create_source_exists

Boolean

基于分支是否存在

latest_pipeline

PipelineBasicDto object

流水线基本信息

opened_mr_count

Integer

该分支正在开启的合并请求个数

取值范围：

0-2147483647

diverging_commit_counts

DivergingCommitCounts object

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

用户名

related_id

String

关联工作项ID

related_url

String

关联工作URL

id

Integer

参数解释：

用户id。

取值范围：

1-2147483647

name

String

参数解释：

用户名称。

username

String

参数解释：

用户名。

state

String

用户状态

service_license_status

Integer

服务级权限状态 0：停用 1：启用

avatar_url

String

用户头像url

avatar_path

String

用户头像路径

email

String

用户邮箱

name_cn

String

用户中文名称

web_url

String

用户个人首页

nick_name

String

用户昵称

tenant_name

String

租户名称

error_message

String

参数解释：

部分查询接口校验到传参里的用户权限不足或不存在时，返回该用户但该字段不为空用于提示。

id

Integer

流水线ID

取值范围：

1-2147483647

web_url

String

流水线链接

sha

String

commit id

ref

String

分支

status

String

流水线状态，pending为排队，running为运行中，success为成功，failed为失败，canceled为取消，skipped为跳过，timedout为超时

枚举值：

• pending

• running

• success

• failed

• canceled

• skipped

• timedout

behind

Integer

落后默认分支提交数量

ahead

Integer

领先默认分支提交数量

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

201

OK

401

Unauthorized