文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ Repository/ 创建仓库提交规则 - CreateRepositoryCommitRule
更新时间:2026-01-19 GMT+08:00
分享

创建仓库提交规则 - CreateRepositoryCommitRule

功能介绍

创建仓库提交规则

调试

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

授权信息

账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

codeartsrepo:repository:setRepository

Write

-

-

-

-

URI

POST /v4/repositories/{repository_id}/commit-rules

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

Integer

参数解释:

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

约束限制:

不涉及。

默认取值:

不涉及。

取值范围:

1~2147483647

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及。

取值范围:

字符串长度不少于1,不超过10万。

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

参数解释:

规则名称。

约束限制:

必填。

取值范围:

不涉及。

默认取值:

不涉及。

branch_name

String

参数解释:

分支规则。

约束限制:

必填。

取值范围:

不涉及。

默认取值:

不涉及。

commit_message_regex

String

参数解释:

提交信息匹配规则。

所有提交消息都必须进行正则表达式匹配, 例如: \d+..*。 若符合正则匹配,则允许提交。若此字段为空,则允许任何提交消息。 您也可以设置在提交信息中必须包含工作项单号,实现代码的E2E追溯。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

commit_message_negative_regex

String

参数解释:

提交信息负面匹配规则。

所有提交消息都必须进行正则表达式匹配,例如: \d+..*。 符合正则匹配,则不允许提交。若此字段为空,则允许任何提交消息。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

author_regex

String

参数解释:

提交人的正则表达式。

提交人必须进行正则表达式匹配, 例如: /([a-zA-Z]\d){7}/。如果此字段为空,则允许任何提交人。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

author_email_regex

String

参数解释:

提交人邮箱地址的正则表达式。

所有提交者邮箱地址都必须进行正则表达式匹配, 例如: @my-company.com$。如果此字段为空,则允许任何提交邮箱地址。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

prohibited_file_name_regex

String

参数解释:

禁止提交的文件名称的正则表达式。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

max_file_size

Integer

参数解释:

单文件大小限制(MB)。

单文件大小超过上述规格的添加或更新推送将被拒绝,Repo建议的最佳上限值为50MB。 系统支持单文件提交的最大值为300MB。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

50

取值范围:

1~300

binary_gate_enabled

Boolean

参数解释:

禁止新增二进制文件(对特权用户无效)。

约束限制:

不涉及。

取值范围:

  • true,禁止新增二进制文件。

  • false,允许新增二进制文件。

默认取值:

不涉及。

allowed_modify_binary

Boolean

参数解释:

允许修改二进制文件(对特权用户无效)。

约束限制:

不涉及。

取值范围:

  • true,允许修改二进制文件。

  • false,禁止修改二进制文件。

默认取值:

不涉及。

allowed_binary_file_name_regex

String

参数解释:

二进制文件白名单(可直接入库的文件)。

所有被推送的二进制文件名必须进行正则表达式匹配, 例如: (.png|.xls|.xlsx|.docx|.doc)$ 。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

privileged_user_ids

Array of integers

参数解释:

特权用户ID列表(特权用户可直接推送所有二进制文件入库。

只有特权用户能推送二进制文件。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

取值范围:

1~2147483647

effective_date

String

参数解释:

规则生效时间, 例如: 2025-8-19。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

skip_rule_check

Boolean

参数解释:

跳过规则检测。

约束限制:

仅CR仓库支持此参数。

取值范围:

不涉及。

默认取值:

不涉及。

skip_rule_end_date

String

参数解释:

跳过规则检测失效时间, 例如: 2025-8-19 10:00:00。

约束限制:

仅CR仓库支持此参数。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

id

Integer

参数解释:

主键ID。

取值范围:

不涉及。

取值范围:

1~2147483647

repository_id

Integer

参数解释:

仓库ID。

取值范围:

不涉及。

取值范围:

1~2147483647

commit_message_regex

String

参数解释:

提交信息匹配规则。

commit_message_negative_regex

String

参数解释:

提交信息负面匹配规则。

prohibited_file_name_regex

String

参数解释:

禁止提交的文件名称。

author_email_regex

String

参数解释:

提交人邮箱地址。

max_file_size

Integer

参数解释:

单文件大小限制(MB)。

取值范围:

0~300

allowed_max_file_size

Integer

参数解释:

允许的最大单文件大小(MB)。

取值范围:

0~300

effective_date

String

参数解释:

规则生效时间。

binary_gate_enabled

Boolean

参数解释:

是否禁止新增二进制文件(对特权用户无效)。

约束限制:

不涉及。

取值范围:

  • true,禁止新增二进制文件。

  • false,允许新增二进制文件。

privileged_users

Array of RepositoryUserBasicDto objects

参数解释:

特权用户(特权用户可直接推送所有二进制文件入库)。

allowed_modify_binary

Boolean

参数解释:

是否允许修改二进制文件(对特权用户无效)。

约束限制:

不涉及。

取值范围:

  • true,允许修改二进制文件。

  • false,禁止修改二进制文件。

allowed_binary_file_name_regex

String

参数解释:

二进制文件白名单(可直接入库的文件)。

author_regex

AnyType

参数解释:

提交人。

updated_at

String

参数解释:

更新时间。

name

String

参数解释:

规则名称。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

branch_name

String

参数解释:

分支规则。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

created_at

String

参数解释:

创建时间。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

skip_rule_check

Boolean

参数解释:

跳过规则检测。

约束限制:

仅CR仓库支持此参数。

skip_rule_end_date

String

参数解释:

跳过规则检测失效时间, 例如: 2025-8-19。

约束限制:

仅CR仓库支持此参数。

表5 RepositoryUserBasicDto

参数

参数类型

描述

id

Integer

参数解释:

用户id

约束限制:

不涉及。

取值范围:

1~2147483647

name

String

参数解释:

用户名称

约束限制:

不涉及。

username

String

参数解释:

用户名

约束限制:

不涉及。

state

String

参数解释:

用户状态。

取值范围:

  • active,激活。

  • blocked,禁用。

service_license_status

Integer

参数解释:

服务级权限状态 0:停用 1:启用

约束限制:

不涉及。

取值范围:

1~2147483647

name_cn

String

参数解释:

用户中文名称

约束限制:

不涉及。

nick_name

String

参数解释:

用户昵称

约束限制:

不涉及。

tenant_name

String

参数解释:

租户名称

约束限制:

不涉及。

请求示例

创建仓库提交规则

POST /v4/repositories/{repository_id}/commit-rules

{
  "binary_gate_enabled" : true,
  "allowed_modify_binary" : true,
  "max_file_size" : 50,
  "effective_date" : null,
  "privileged_user_ids" : [ 9124 ],
  "name" : "fffffff2233",
  "branch_name" : "mas1*"
}

响应示例

状态码:200

仓库提交规则

{
  "id" : 169352,
  "repository_id" : 2112035798,
  "commit_message_regex" : "test",
  "commit_message_negative_regex" : "test",
  "prohibited_file_name_regex" : "test",
  "author_email_regex" : "test",
  "max_file_size" : 50,
  "allowed_max_file_size" : 300,
  "effective_date" : "2025-01-14T20:13:56.000+08:00",
  "binary_gate_enabled" : true,
  "privileged_users" : [ {
    "id" : 9124,
    "name" : "test_user",
    "username" : "test_user",
    "state" : "active",
    "service_license_status" : null,
    "name_cn" : "test_user",
    "nick_name" : "beta_dv",
    "tenant_name" : "test_tenant"
  } ],
  "allowed_modify_binary" : true,
  "allowed_binary_file_name_regex" : "test",
  "author_regex" : "test",
  "name" : "2",
  "branch_name" : "2",
  "created_at" : "2025-06-20T17:37:55.000+08:00",
  "updated_at" : "2025-06-20T17:37:55.000+08:00"
}

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
55
56
57
58
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 CreateRepositoryCommitRuleSolution {

    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("<YOUR REGION>"))
                .build();
        CreateRepositoryCommitRuleRequest request = new CreateRepositoryCommitRuleRequest();
        request.withRepositoryId({repository_id});
        CommitRuleCreateBodyDto body = new CommitRuleCreateBodyDto();
        List<Integer> listbodyPrivilegedUserIds = new ArrayList<>();
        listbodyPrivilegedUserIds.add(9124);
        body.withPrivilegedUserIds(listbodyPrivilegedUserIds);
        body.withAllowedModifyBinary(true);
        body.withBinaryGateEnabled(true);
        body.withMaxFileSize(50);
        body.withBranchName("mas1*");
        body.withName("fffffff2233");
        request.withBody(body);
        try {
            CreateRepositoryCommitRuleResponse response = client.createRepositoryCommitRule(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
40
41
42
# 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("<YOUR REGION>")) \
        .build()

    try:
        request = CreateRepositoryCommitRuleRequest()
        request.repository_id = {repository_id}
        listPrivilegedUserIdsbody = [
            9124
        ]
        request.body = CommitRuleCreateBodyDto(
            privileged_user_ids=listPrivilegedUserIdsbody,
            allowed_modify_binary=True,
            binary_gate_enabled=True,
            max_file_size=50,
            branch_name="mas1*",
            name="fffffff2233"
        )
        response = client.create_repository_commit_rule(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"
    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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := codeartsrepo.NewCodeArtsRepoClient(
        codeartsrepo.CodeArtsRepoClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateRepositoryCommitRuleRequest{}
	request.RepositoryId = int32({repository_id})
	var listPrivilegedUserIdsbody = []int32{
        int32(9124),
    }
	allowedModifyBinaryCommitRuleCreateBodyDto:= true
	binaryGateEnabledCommitRuleCreateBodyDto:= true
	maxFileSizeCommitRuleCreateBodyDto:= int32(50)
	request.Body = &model.CommitRuleCreateBodyDto{
		PrivilegedUserIds: &listPrivilegedUserIdsbody,
		AllowedModifyBinary: &allowedModifyBinaryCommitRuleCreateBodyDto,
		BinaryGateEnabled: &binaryGateEnabledCommitRuleCreateBodyDto,
		MaxFileSize: &maxFileSizeCommitRuleCreateBodyDto,
		BranchName: "mas1*",
		Name: "fffffff2233",
	}
	response, err := client.CreateRepositoryCommitRule(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

仓库提交规则

错误码

请参见错误码

相关文档