# 创建项目下保护分支 - CreateProjectProtectedBranches #### 功能介绍 创建项目下保护分支 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CodeArtsRepo/doc?api=CreateProjectProtectedBranches&version=v4)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-codeartsrepo/codeartsrepo_05_0036.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | codeartsrepo::createProjectSetting | Write | - | codeartsrepo:ProjectId | - | - | #### URI POST /v4/projects/{project_id}/protected-branches 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目的32位uuid，项目唯一标识，通过[查询项目列表](https://support.huaweicloud.com/api-projectman/ListProjectsV4.html)接口查询项目列表获取。 **取值范围：** 字符串长度32。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及。 **取值范围：** 字符串长度不少于1，不超过10万。 **默认取值：** 不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 是 | String | **参数解释：** 保护分支名称。 **取值范围** 字符串长度不少于1，不超过1000。 | | actions | 否 | Array of [ProtectedActionBasicApiDto] objects | **参数解释：** 事件列表。 | 表4ProtectedActionBasicApiDto | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | action | 否 | String | **参数解释：** 事件名称。 **取值范围：push 提交,merge 合并** 字符串长度不少于1，不超过1000。 | | enable | 否 | Boolean | **参数解释：** 是否启用。 | | user_ids | 否 | Array of integers | **参数解释：** 用户ID列表。 **约束限制：** 不涉及。 **取值范围：** Integer **默认取值：** 不涉及。 **取值范围：** 1\~2147483647 | | user_team_ids | 否 | Array of integers | **参数解释：** 成员组ID列表。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 **取值范围：** 1\~2147483647 | | related_role_ids | 否 | Array of strings | **参数解释：** 关联角色ID列表。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | addition_switchers | 否 | Array of [ForceActionEnableDto] objects | **参数解释：** 操作选择列表。 | 表5ForceActionEnableDto | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | **参数解释：** 强制操作名称。 **取值范围：** 字符串长度不少于1，不超过1000。 | | enable | 否 | Boolean | **参数解释：** 强制操作是否开启。 | #### 响应参数 **状态码：200** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | Integer | **参数解释：** 保护分支唯一标识。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 **取值范围：** 1\~2147483647 | | name | String | **参数解释：** 保护分支名称 **取值范围：** 字符串长度不少于1，不超过1000。 **约束限制：** 不涉及 **默认取值：** 不涉及 | | actions | Array of [ProjectProtectedActionResultApiDto] objects | **参数解释：** 事件列表。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表7ProjectProtectedActionResultApiDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | action | String | **参数解释：** 事件名称。 **取值范围：** 字符串长度不少于1，不超过1000。 | | enable | Boolean | **参数解释：** 是否启用。 | | users | Array of [UserBasicDto] objects | **参数解释：** 用户列表。 | | user_teams | Array of [UserTeamBasicDto] objects | **参数解释：** 成员组列表。 | | roles | Array of [RoleBasicDto] objects | **参数解释：** 角色列表。 | | addition_switchers | Array of [ForceActionEnableDto] objects | **参数解释：** 操作选择列表。 | 表8UserBasicDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | Integer | **参数解释：** 用户id。 **取值范围：** 1\~2147483647 | | name | String | **参数解释：** 用户名称。 | | username | String | **参数解释：** 用户名。 | | state | String | **参数解释：** 用户状态。 **取值范围：** - active: 可用账户。 - blocked: 被锁定用户。 - error: 未查询到该用户。 | | 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 | **参数解释：** 部分查询接口校验到传参里的用户权限不足或不存在时，返回该用户但该字段不为空用于提示。 | 表9UserTeamBasicDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | Integer | **参数解释：** 用户组ID。 **取值范围：** 1-2147483647 | | name | String | **参数解释：** 用户组名称。 **取值范围：** 不涉及。 | 表10RoleBasicDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | Integer | **参数解释：** 角色唯一标识。 **取值范围：** 1\~2147483647 | | name | String | **参数解释：** 角色名称。 **取值范围：** 字符串长度不少于1，不超过1000。 | | related_role_id | String | **参数解释：** 角色id。 **取值范围：** 字符串长度不少于1，不超过1000。 | | chinese_name | String | **参数解释：** 角色中文名称。 **取值范围：** 字符串长度不少于1，不超过1000。 | 表11ForceActionEnableDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释：** 强制操作名称。 **取值范围：** 字符串长度不少于1，不超过1000。 | | enable | Boolean | **参数解释：** 强制操作是否开启。 | #### 请求示例 创建项目下保护分支 ``` POST https://{endpoint}/v4/projects/3132f98fb2c44430ba68f356af3a8e0d/protected-branche { "name" : "212", "actions" : [ { "action" : "push", "enable" : true, "user_ids" : [ 9124 ], "user_team_ids" : [ 247 ], "related_role_ids" : [ "6115a3ddd9044e288c558d1ae827a732", "8425999e92974f2980b76b08ad423aa1", "f2464b129b064a6a988734a73c3f366b", "24f72d0b611746c3a43da596ea5065f5" ] }, { "action" : "merge", "enable" : true, "user_ids" : [ 9124 ], "user_team_ids" : [ 247 ], "related_role_ids" : [ "Administrator", "8425999e92974f2980b76b08ad423aa1", "f2464b129b064a6a988734a73c3f366b", "24f72d0b611746c3a43da596ea5065f5" ] } ] } ``` #### 响应示例 **状态码：200** 项目下保护分支详情 ``` { "id" : 260, "name" : "212", "actions" : [ { "action" : "push", "enable" : true, "users" : [ { "id" : 9087, "name" : "test11", "username" : "04ef19ad5eaf4b8c9cf2451d3536202d", "state" : "blocked", "avatar_url" : null, "avatar_path" : null, "email" : null, "name_cn" : null, "web_url" : null, "nick_name" : "", "tenant_name" : "devcloud_codehub_l00314597_01", "error_message" : null } ], "user_teams" : [ { "id" : 312, "name" : "team1" } ], "roles" : [ { "id" : 35471438, "name" : "Administrator", "related_role_id" : "e134545ad4724ea0b77a00a0fec5cd4c", "chinese_name" : "管理员" } ], "addition_switchers" : [ { "name" : "allowed_force_push", "enable" : false } ] }, { "action" : "merge", "enable" : true, "users" : [ ], "user_teams" : [ ], "roles" : [ ], "addition_switchers" : null } ] } ``` #### SDK代码示例 SDK代码示例如下。 #### Java 创建项目下保护分支 ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.codeartsrepo.v4.region.CodeArtsRepoRegion; import com.huaweicloud.sdk.codeartsrepo.v4.*; import com.huaweicloud.sdk.codeartsrepo.v4.model.*; import java.util.List; import java.util.ArrayList; public class CreateProjectProtectedBranchesSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); CodeArtsRepoClient client = CodeArtsRepoClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsRepoRegion.valueOf("")) .build(); CreateProjectProtectedBranchesRequest request = new CreateProjectProtectedBranchesRequest(); request.withProjectId("{project_id}"); ProtectedBranchBodyApiDto body = new ProtectedBranchBodyApiDto(); List listActionsRelatedRoleIds = new ArrayList<>(); listActionsRelatedRoleIds.add("Administrator"); listActionsRelatedRoleIds.add("8425999e92974f2980b76b08ad423aa1"); listActionsRelatedRoleIds.add("f2464b129b064a6a988734a73c3f366b"); listActionsRelatedRoleIds.add("24f72d0b611746c3a43da596ea5065f5"); List listActionsUserTeamIds = new ArrayList<>(); listActionsUserTeamIds.add(247); List listActionsUserIds = new ArrayList<>(); listActionsUserIds.add(9124); List listActionsRelatedRoleIds1 = new ArrayList<>(); listActionsRelatedRoleIds1.add("6115a3ddd9044e288c558d1ae827a732"); listActionsRelatedRoleIds1.add("8425999e92974f2980b76b08ad423aa1"); listActionsRelatedRoleIds1.add("f2464b129b064a6a988734a73c3f366b"); listActionsRelatedRoleIds1.add("24f72d0b611746c3a43da596ea5065f5"); List listActionsUserTeamIds1 = new ArrayList<>(); listActionsUserTeamIds1.add(247); List listActionsUserIds1 = new ArrayList<>(); listActionsUserIds1.add(9124); List listbodyActions = new ArrayList<>(); listbodyActions.add( new ProtectedActionBasicApiDto() .withAction(ProtectedActionBasicApiDto.ActionEnum.fromValue("push")) .withEnable(true) .withUserIds(listActionsUserIds1) .withUserTeamIds(listActionsUserTeamIds1) .withRelatedRoleIds(listActionsRelatedRoleIds1) ); listbodyActions.add( new ProtectedActionBasicApiDto() .withAction(ProtectedActionBasicApiDto.ActionEnum.fromValue("merge")) .withEnable(true) .withUserIds(listActionsUserIds) .withUserTeamIds(listActionsUserTeamIds) .withRelatedRoleIds(listActionsRelatedRoleIds) ); body.withActions(listbodyActions); body.withName("212"); request.withBody(body); try { CreateProjectProtectedBranchesResponse response = client.createProjectProtectedBranches(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` #### Python 创建项目下保护分支 ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodeartsrepo.v4.region.codeartsrepo_region import CodeArtsRepoRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartsrepo.v4 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = CodeArtsRepoClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsRepoRegion.value_of("")) \ .build() try: request = CreateProjectProtectedBranchesRequest() request.project_id = "{project_id}" listRelatedRoleIdsActions = [ "Administrator", "8425999e92974f2980b76b08ad423aa1", "f2464b129b064a6a988734a73c3f366b", "24f72d0b611746c3a43da596ea5065f5" ] listUserTeamIdsActions = [ 247 ] listUserIdsActions = [ 9124 ] listRelatedRoleIdsActions1 = [ "6115a3ddd9044e288c558d1ae827a732", "8425999e92974f2980b76b08ad423aa1", "f2464b129b064a6a988734a73c3f366b", "24f72d0b611746c3a43da596ea5065f5" ] listUserTeamIdsActions1 = [ 247 ] listUserIdsActions1 = [ 9124 ] listActionsbody = [ ProtectedActionBasicApiDto( action="push", enable=True, user_ids=listUserIdsActions1, user_team_ids=listUserTeamIdsActions1, related_role_ids=listRelatedRoleIdsActions1 ), ProtectedActionBasicApiDto( action="merge", enable=True, user_ids=listUserIdsActions, user_team_ids=listUserTeamIdsActions, related_role_ids=listRelatedRoleIdsActions ) ] request.body = ProtectedBranchBodyApiDto( actions=listActionsbody, name="212" ) response = client.create_project_protected_branches(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` #### Go 创建项目下保护分支 ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codeartsrepo "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsrepo/v4" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsrepo/v4/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsrepo/v4/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := codeartsrepo.CodeArtsRepoClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := codeartsrepo.NewCodeArtsRepoClient(hcClient) request := &model.CreateProjectProtectedBranchesRequest{} request.ProjectId = "{project_id}" var listRelatedRoleIdsActions = []string{ "Administrator", "8425999e92974f2980b76b08ad423aa1", "f2464b129b064a6a988734a73c3f366b", "24f72d0b611746c3a43da596ea5065f5", } var listUserTeamIdsActions = []int32{ int32(247), } var listUserIdsActions = []int32{ int32(9124), } var listRelatedRoleIdsActions1 = []string{ "6115a3ddd9044e288c558d1ae827a732", "8425999e92974f2980b76b08ad423aa1", "f2464b129b064a6a988734a73c3f366b", "24f72d0b611746c3a43da596ea5065f5", } var listUserTeamIdsActions1 = []int32{ int32(247), } var listUserIdsActions1 = []int32{ int32(9124), } actionActions:= model.GetProtectedActionBasicApiDtoActionEnum().PUSH enableActions:= true actionActions1:= model.GetProtectedActionBasicApiDtoActionEnum().MERGE enableActions1:= true var listActionsbody = []model.ProtectedActionBasicApiDto{ { Action: &actionActions, Enable: &enableActions, UserIds: &listUserIdsActions1, UserTeamIds: &listUserTeamIdsActions1, RelatedRoleIds: &listRelatedRoleIdsActions1, }, { Action: &actionActions1, Enable: &enableActions1, UserIds: &listUserIdsActions, UserTeamIds: &listUserTeamIdsActions, RelatedRoleIds: &listRelatedRoleIdsActions, }, } request.Body = &model.ProtectedBranchBodyApiDto{ Actions: &listActionsbody, Name: "212", } response, err := client.CreateProjectProtectedBranches(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` #### 更多 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CodeArtsRepo/sdk?api=CreateProjectProtectedBranches&version=v4)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 项目下保护分支详情 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-codeartsrepo/ErrorCode.html)。