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

查看仓库提交规则

功能介绍

查看仓库提交规则

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

Integer

参数解释:

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

约束限制:

不涉及。

取值范围:

1-2147483647

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

参数解释:

偏移量,从0开始。

取值范围:

0-2147483647

默认取值:

0

limit

Integer

参数解释:

返回数量。

取值范围:

1-100

默认取值:

20

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

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

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Header参数

参数

参数类型

描述

X-Total

String

当前请求的结果总条数

表5 响应Body参数

参数

参数类型

描述

[数组元素]

Array of CommitRuleDto objects

仓库提交规则列表

表6 CommitRuleDto

参数

参数类型

描述

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仓库支持此参数。

表7 RepositoryUserBasicDto

参数

参数类型

描述

id

Integer

参数解释:

用户id

约束限制:

不涉及。

取值范围:

1-2147483647

name

String

参数解释:

用户名称

约束限制:

不涉及。

username

String

参数解释:

用户名

约束限制:

不涉及。

state

String

参数解释:

用户状态。

取值范围:

  • active,激活。

  • blocked,禁用。

枚举值:

  • active

  • blocked

service_license_status

Integer

参数解释:

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

约束限制:

不涉及。

取值范围:

1-2147483647

name_cn

String

参数解释:

用户中文名称

约束限制:

不涉及。

nick_name

String

参数解释:

用户昵称

约束限制:

不涉及。

tenant_name

String

参数解释:

租户名称

约束限制:

不涉及。

请求示例

响应示例

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

    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();
        ListRepositoryCommitRulesRequest request = new ListRepositoryCommitRulesRequest();
        request.withRepositoryId({repository_id});
        try {
            ListRepositoryCommitRulesResponse response = client.listRepositoryCommitRules(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
# 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 = ListRepositoryCommitRulesRequest()
        request.repository_id = {repository_id}
        response = client.list_repository_commit_rules(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
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.ListRepositoryCommitRulesRequest{}
	request.RepositoryId = int32({repository_id})
	response, err := client.ListRepositoryCommitRules(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

仓库提交规则列表

错误码

请参见错误码

相关文档