查询指定代码库的保护分支列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。

请求语法

GET /api/v4/projects/{ProjectId}/repository/protect_branches HTTP/1.1

请求参数

名称 类型 位置 是否必选 示例值 描述
AccessToken String Query 否 146dd344827fe2444f952e931e51xxxx

个人访问令牌。

使用阿里云AK+SK或使用STS临时授权方式不需要传该字段
ProjectId Long Path 是 100

代码库ID
OrganizationId String Query 是 60811b5eed6e867404f6xxxx

企业标识，也称企业id，字符串形式，可在云效访问链接中获取，如

https://devops.aliyun.com/organization/

返回数据

名称 类型 示例值 描述
ErrorMessage String 代码库不存在

错误信息
RequestId String xxxx-xxxx-xxxx-xxxx

请求ID
Success Boolean true

请求结果
ErrorCode String SYSTEM_NOT_FOUND_ERROR

错误码
Result Array of result

响应结果
Branch String master

保护分支名称
Id Long 100

保护分支 ID
AllowPushRoles Array of Integer 40

允许推送代码的角色。 40：管理员 30：开发者
AllowMergeRoles Array of Integer 40

允许合并的角色。 40：管理员 30：开发者
MergeRequestSetting Object

代码评审设置
MergeRequestMode String general

评审模式。 general：普通 codeowner：CodeOwner模式
AllowSelfApproval Boolean false

是否允许创建者通过代码评审。
IsRequireDiscussionProcessed Boolean false

是否要求评论全部已解决。
Required Boolean true

是否要求合并前通过代码评审。
MinimumApproval Integer 1

评审通过的最少人数。 注：仅普通模式生效。
DefaultAssignees Array of DefaultAssignees

默认评审者。 注：云效用户 ID 列表。
Name String ZhenRan

姓名
ExternUid String 5e72f082032838332xxxxxxx

云效用户ID
AvatarUrl String https://xxxxxx

头像地址
Id Long 100

用户ID
Email String test@xxx.com

邮箱
AllowMergeRequestRoles Array of Integer 40

允许通过代码评审的角色。 40：管理员 30：开发者
WhiteList String test

评审文件白名单
TestSetting Object

自动化检查设置
Required Boolean false

要求合并前通过自动化执行检查。
CodingGuidelinesDetection Object

Java 代码规约扫描
Message String ""

检查信息
Enabled Boolean true

合并前是否需要通过Java代码规约扫描。
SensitiveInfoDetection Object

敏感信息检查
Message String ""

检查信息
Enabled Boolean true

合并前是否需要通过敏感信息检查
CheckConfig Object

卡点检测
CheckItems Array of CheckItems

流水线检测列表
Name String 流水线2021-xx-xx

流水线名称
Required Boolean true

是否开启检测

示例

请求示例

正常返回示例

JSON格式

HTTP/1.1 200 OK

错误码

访问错误中心查看更多错误码。