更新时间:2025-09-28 GMT+08:00
分享

修改仓库通用策略

功能介绍

修改仓库通用策略

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

PUT /v4/repositories/{repository_id}/general-policy

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

Integer

参数解释:

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

约束限制:

不涉及。

取值范围:

1-2147483647

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中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使用逗号分隔。

响应参数

状态码: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

参数解释:

开发人员创建分支权限白名单。

表5 PushRuleDevelopersDto

参数

参数类型

描述

id

AnyType

参数解释:

主键ID。

取值范围:

1-2147483647

user_id

AnyType

参数解释:

用户ID。

取值范围:

1-2147483647

user_name

AnyType

参数解释:

用户名。

nick_name

String

参数解释:

昵称。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

tenant_name

String

参数解释:

租户名。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求示例

修改仓库通用策略

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

修改仓库通用策略

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
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.codehub.v4.region.CodeHubRegion;
import com.huaweicloud.sdk.codehub.v4.*;
import com.huaweicloud.sdk.codehub.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);

        CodeHubClient client = CodeHubClient.newBuilder()
                .withCredential(auth)
                .withRegion(CodeHubRegion.valueOf("<YOUR REGION>"))
                .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

修改仓库通用策略

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcodehub.v4.region.codehub_region import CodeHubRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcodehub.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 = CodeHubClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CodeHubRegion.value_of("<YOUR REGION>")) \
        .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

修改仓库通用策略

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    codehub "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v4"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v4/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := codehub.NewCodeHubClient(
        codehub.CodeHubClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    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的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

仓库通用策略

错误码

请参见错误码

相关文档