# 修改仓库通用策略 - UpdateRepositoryGeneralPolicy #### 功能介绍 修改仓库通用策略 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CodeArtsRepo/doc?api=UpdateRepositoryGeneralPolicy&version=v4)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-codeartsrepo/codeartsrepo_05_0036.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | codeartsrepo:repository:setRepository | Write | - | - | - | - | #### URI PUT /v4/repositories/{repository_id}/general-policy 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | repository_id | 是 | Integer | **参数解释：** 仓库的ID，通过[查询用户所有仓库](https://support.huaweicloud.com/api-codeartsrepo/ListUserAllRepositories.html)接口查询项目列表获取。 **约束限制：** 不涉及。 **默认取值：** 不涉及。 **取值范围：** 1\~2147483647 | #### 请求参数 表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参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | disable_fork | 否 | Boolean | **参数解释：** 是否禁止fork该仓库。 **约束限制：** 不涉及。 **取值范围：** - true，禁止fork。 - false，允许fork。 **默认取值：** 不涉及。 | | generate_pre_merge_ref | 否 | Boolean | **参数解释：** 是否预合并MR。 **约束限制：** 不涉及。 **取值范围：** - true，禁止预合并MR。 - false，允许预合并MR。 **默认取值：** 不涉及。 | | branch_name_regex | 否 | String | **参数解释：** 分支名规则。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | tag_name_regex | 否 | String | **参数解释：** Tag名规则。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | forbidden_developer_create_branch | 否 | Boolean | **参数解释：** 是否禁止开发者创建分支。 **约束限制：** 不涉及。 **取值范围：** - true，禁止开发者创建分支。 - false，允许开发者创建分支。 | | create_branch_whitelist_user_ids | 否 | String | **参数解释：** 开发人员创建分支权限例外白名单。多个用户ID使用逗号分隔。 | | repo_encryption_enabled | 否 | Boolean | **参数解释：** 是否开启仓库加密。 **约束限制：** 不涉及。 **取值范围：** - true，开启仓库加密。 - false，关闭仓库加密。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | disable_fork | Boolean | **参数解释：** 是否禁止fork该仓库。 **约束限制：** 不涉及。 **取值范围：** - true，禁止fork。 - false，允许fork。 **默认取值：** 不涉及。 | | generate_pre_merge_ref | Boolean | **参数解释：** 是否预合并MR。 **约束限制：** 不涉及。 **取值范围：** - true，禁止预合并MR。 - false，允许预合并MR。 **默认取值：** 不涉及。 | | branch_name_regex | String | **参数解释：** 分支名规则。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | tag_name_regex | String | **参数解释：** Tag名规则。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | forbidden_developer_create_branch | Boolean | **参数解释：** 是否禁止开发者创建分支。 **约束限制：** 不涉及。 **取值范围：** - true，禁止开发者创建分支。 - false，允许开发者创建分支。 | | create_branch_whitelist_users | Array of [PushRuleDevelopersDto] objects | **参数解释：** 开发人员创建分支权限白名单。 | | repo_encryption_enabled | Boolean | **参数解释：** 是否开启仓库加密。 **约束限制：** 不涉及。 **取值范围：** - true，开启仓库加密。 - false，关闭仓库加密。 | | repo_encryption_status | [ProjectEncryptionStatusBriefDto] object | **参数解释：** 使用代码仓库加密的状态。 | 表5PushRuleDevelopersDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | AnyType | **参数解释：** 主键ID。 **取值范围：** 1\~2147483647 | | user_id | AnyType | **参数解释：** 用户ID。 **取值范围：** 1\~2147483647 | | user_name | AnyType | **参数解释：** 用户名。 | | nick_name | String | **参数解释：** 昵称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | tenant_name | String | **参数解释：** 租户名。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表6ProjectEncryptionStatusBriefDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | Integer | **参数解释：** 仓库加密状态ID。 **取值范围：** 不涉及。 **取值范围：** 1\~2147483647 | | status | String | **参数解释：** 仓库加密状态 **取值范围：** - encrypting，加密中。 - encrypted，已加密。 - decrypting，解密中。 - decrypted，已解密。 **默认取值：** 不涉及。 | | last_encryption_at | String | **参数解释：** 最近加密时间。 **取值范围：** 不涉及。 | | last_decryption_at | String | **参数解释：** 最近解密时间。 **取值范围：** 不涉及。 | | is_consistent | Boolean | **参数解释：** 是否开启仓库加密。 **约束限制：** 不涉及。 **取值范围：** - true，开启仓库加密。 - false，关闭仓库加密。 | #### 请求示例 修改仓库通用策略 ``` PUT /v4/repositories/123/general-policy { "disable_fork" : true, "generate_pre_merge_ref" : true, "branch_name_regex" : "^[0-9]*$", "tag_name_regex" : "^[0-9]*$", "forbidden_developer_create_branch" : true, "create_branch_whitelist_user_ids" : "9458,1234" } ``` #### 响应示例 **状态码：200** 仓库通用策略 ``` { "disable_fork" : true, "generate_pre_merge_ref" : true, "branch_name_regex" : "^[0-9]*$", "tag_name_regex" : "^[0-9]*$", "forbidden_developer_create_branch" : true, "create_branch_whitelist_users" : [ { "id" : "198,", "user_id" : "9458,", "user_name" : "test_01", "nick_name" : "test_01", "tenant_name" : "test" }, { "id" : "198,", "user_id" : "1234,", "user_name" : "test_02", "nick_name" : "test_02", "tenant_name" : "t" } ] } ``` #### 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.*; public class UpdateRepositoryGeneralPolicySolution { 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(); UpdateRepositoryGeneralPolicyRequest request = new UpdateRepositoryGeneralPolicyRequest(); request.withRepositoryId({repository_id}); GeneralPolicyBodyDto body = new GeneralPolicyBodyDto(); body.withCreateBranchWhitelistUserIds("9458,1234"); body.withForbiddenDeveloperCreateBranch(true); body.withTagNameRegex("^[0-9]*$"); body.withBranchNameRegex("^[0-9]*$"); body.withGeneratePreMergeRef(true); body.withDisableFork(true); request.withBody(body); try { UpdateRepositoryGeneralPolicyResponse response = client.updateRepositoryGeneralPolicy(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 = UpdateRepositoryGeneralPolicyRequest() request.repository_id = {repository_id} request.body = GeneralPolicyBodyDto( create_branch_whitelist_user_ids="9458,1234", forbidden_developer_create_branch=True, tag_name_regex="^[0-9]*$", branch_name_regex="^[0-9]*$", generate_pre_merge_ref=True, disable_fork=True ) response = client.update_repository_general_policy(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.UpdateRepositoryGeneralPolicyRequest{} request.RepositoryId = int32({repository_id}) createBranchWhitelistUserIdsGeneralPolicyBodyDto:= "9458,1234" forbiddenDeveloperCreateBranchGeneralPolicyBodyDto:= true tagNameRegexGeneralPolicyBodyDto:= "^[0-9]*$" branchNameRegexGeneralPolicyBodyDto:= "^[0-9]*$" generatePreMergeRefGeneralPolicyBodyDto:= true disableForkGeneralPolicyBodyDto:= true request.Body = &model.GeneralPolicyBodyDto{ CreateBranchWhitelistUserIds: &createBranchWhitelistUserIdsGeneralPolicyBodyDto, ForbiddenDeveloperCreateBranch: &forbiddenDeveloperCreateBranchGeneralPolicyBodyDto, TagNameRegex: &tagNameRegexGeneralPolicyBodyDto, BranchNameRegex: &branchNameRegexGeneralPolicyBodyDto, GeneratePreMergeRef: &generatePreMergeRefGeneralPolicyBodyDto, DisableFork: &disableForkGeneralPolicyBodyDto, } response, err := client.UpdateRepositoryGeneralPolicy(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=UpdateRepositoryGeneralPolicy&version=v4)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 仓库通用策略 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-codeartsrepo/ErrorCode.html)。