文档

CreateProtectdBranch - 创建保护分支

更新时间:

创建代码库保护分支。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

POST /repository/{repositoryId}/protect_branches

请求参数

名称类型必填描述示例值
organizationIdstring

企业标识,也称企业 id,字符串形式,可在云效访问链接中获取,如 https://devops.aliyun.com/organization/【OrganizationId】

60de7a6852743a5162b5f957
accessTokenstring

个人访问令牌。 使用阿里云 AK+SK 或使用 STS 临时授权方式不需要传该字段

f0b1e61db5961df5975a93f9129d2513
repositoryIdlong

代码库 ID

2813891
bodyobject

请求 Body

idlong

保护分支规则 ID

--
branchstring

保护分支名称

protectBranch
allowPushRolesarray

允许推送角色列表

integer

40:管理员
30:开发者

[40, 30]
allowPushUserIdsarray

允许推送用户 ID

string

阿里云账号 ID

2344667212345561
allowMergeRolesarray

允许合并角色列表

integer

40:管理员
30:开发者

[40, 30]
allowMergeUserIdsarray

允许合并用户 ID

string

阿里云账号 ID

123345678912345
mergeRequestSettingobject

合并前的代码评审设置

isRequiredboolean

是否开启

true
mrModestring

评审模式

  • general:普通
  • codeowner:CodeOwner 模式
general
isAllowSelfApprovalboolean

是否允许创建者通过代码评审

true
isRequireDiscussionProcessedboolean

是否要求评论全部已解决

true
isResetApprovalWhenNewPushboolean

是否在有新的提交时重置评审

false
minimumApprovalinteger

评审通过的最少人数

说明 仅普通模式生效
1
allowMergeRequestRolesarray

允许合并角色列表

integer

40:管理员(默认)
30:开发者

[40, 30]
defaultAssigneesarray

默认评审人

string

阿里云账号 ID

1234567891234567
whiteListstring

评审文件白名单

注意 加入白名单的文件不受「评审通过的最少人数」限制,无需强制人工评审

**.java
testSettingDTOobject

合并前的自动化状态检查设置

isRequiredboolean

是否开启

false
codeGuidelinesDetectionobject

代码规约扫描

enabledboolean

是否开启

false
messagestring

描述信息

test_code_guide_lines
sensitiveInfoDetectionobject

敏感信息扫描

enabledboolean

是否开启

false
messagestring

描述信息

test_code_sensitive_info
checkTaskQualityConfigobject

代码质量检测

enabledboolean

是否开启

false
bizNostring

任务流水号

123456
taskNamestring

任务名称

bz-task-quality
messagestring

信息

test_task_quality
checkConfigobject

MR 卡点流水线配置

checkItemsarray<object>

配置项

object

配置项

namestring

流水线名称

测试流水线
isRequiredboolean

是否卡点

false

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

请求 ID

C2F153F6-BB43-50C4-9F4F-40593203E19A
errorMessagestring

错误信息

""
errorCodestring

错误码

Openapi.RequestError
successboolean

调用是否成功

true
resultobject

返回结果

idlong

保护分支规则 ID

5240
branchstring

保护分支名称

protectBranch
allowPushRolesarray

允许推送角色列表

integer

40:管理者
30:开发者

40
allowPushUserIdsarray

允许推送用户 ID 列表

long

Codeup 的用户 ID

19238
allowMergeRolesarray

允许合并角色列表

integer

40:管理者
30:开发者

40
allowMergeUserIdsarray

允许合并用户 ID

long

Codeup 的用户 ID

19238
mergeRequestSettingobject

合并前的代码评审设置

isRequiredboolean

是否开启

true
mrModestring

评审模式

  • general:普通
  • codeowner:CodeOwner 模式
general
isAllowSelfApprovalboolean

是否允许创建者通过代码评审

true
isRequireDiscussionProcessedboolean

是否要求评审全部已解决

true
isResetApprovalWhenNewPushboolean

是否在有新的提交时重置评审

false
minimumApprovalinteger

评审通过的最少人数 注:仅普通模式生效

1
allowMergeRequestRolesarray

允许合并请求角色列表

integer

40:管理员(默认)
30:开发者

40
defaultAssigneesarray

默认评审人 ID

string

云效用户 ID

5f969843cd2214ba0e24327d
whiteListstring

评审文件白名单 注意:加入白名单的文件不受「评审通过的最少人数」限制,无需强制人工评审

**.java
testSettingDTOobject

合并前的自动化状态检查设置

isRequiredboolean

是否开启

false
codeGuidelinesDetectionobject

代码规约扫描

enabledboolean

是否开启

false
messagestring

描述信息

test_code_guide_lines
sensitiveInfoDetectionobject

敏感信息扫描

enabledboolean

是否开启

false
messagestring

描述信息

test_code_sensitive_info
checkTaskQualityConfigobject

代码质量检测

enabledboolean

是否开启

false
bizNostring

任务流水号

123456
taskNamestring

任务名称

biz-task-quality
messagestring

描述信息

test_task_quality
checkConfigobject

MR 卡点流水线配置

checkItemsarray<object>

配置项列表

object

配置项

namestring

流水线名称

测试流水线
isRequiredboolean

是否卡点

false

示例

正常返回示例

JSON格式

{
  "requestId": "C2F153F6-BB43-50C4-9F4F-40593203E19A",
  "errorMessage": "\"\"",
  "errorCode": "Openapi.RequestError",
  "success": true,
  "result": {
    "id": 5240,
    "branch": "protectBranch",
    "allowPushRoles": [
      40
    ],
    "allowPushUserIds": [
      19238
    ],
    "allowMergeRoles": [
      40
    ],
    "allowMergeUserIds": [
      19238
    ],
    "mergeRequestSetting": {
      "isRequired": true,
      "mrMode": "general",
      "isAllowSelfApproval": true,
      "isRequireDiscussionProcessed": true,
      "isResetApprovalWhenNewPush": false,
      "minimumApproval": 1,
      "allowMergeRequestRoles": [
        40
      ],
      "defaultAssignees": [
        "5f969843cd2214ba0e24327d"
      ],
      "whiteList": "**.java"
    },
    "testSettingDTO": {
      "isRequired": false,
      "codeGuidelinesDetection": {
        "enabled": false,
        "message": "test_code_guide_lines"
      },
      "sensitiveInfoDetection": {
        "enabled": false,
        "message": "test_code_sensitive_info"
      },
      "checkTaskQualityConfig": {
        "enabled": false,
        "bizNo": "123456",
        "taskName": "biz-task-quality",
        "message": "test_task_quality"
      },
      "checkConfig": {
        "checkItems": [
          {
            "name": "测试流水线",
            "isRequired": false
          }
        ]
      }
    }
  }
}

错误码

HTTP status code错误码错误信息描述
403Forbidden.AccessDeniedThe user is not authorized to perform the operation.用户无权限执行相关操作
403Forbidden.UserNotInCurrentOrganizationThe user is not in the organization and is not authorized to perform the operation.当前用户不在该企业中,无权进行操作。

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

变更历史

变更时间变更内容概要操作
2023-06-05OpenAPI 错误码发生变更查看变更详情