查看仓库提交规则
功能介绍
查看仓库提交规则
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v4/repositories/{repository_id}/commit-rules
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
repository_id |
是 |
Integer |
参数解释: 仓库的ID,通过查询用户所有仓库接口查询项目列表获取。 约束限制: 不涉及。 取值范围: 1-2147483647 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
Integer |
参数解释: 偏移量,从0开始。 取值范围: 0-2147483647 默认取值: 0 |
limit |
否 |
Integer |
参数解释: 返回数量。 取值范围: 1-100 默认取值: 20 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
X-Total |
Integer |
当前请求的结果总条数 |
参数 |
参数类型 |
描述 |
---|---|---|
[数组元素] |
Array of CommitRuleDto objects |
仓库提交规则列表 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
参数解释: 是否禁止新增二进制文件(对特权用户无效)。 约束限制: 不涉及。 取值范围:
|
privileged_users |
Array of RepositoryUserBasicDto objects |
参数解释: 特权用户(特权用户可直接推送所有二进制文件入库)。 |
allowed_modify_binary |
Boolean |
参数解释: 是否允许修改二进制文件(对特权用户无效)。 约束限制: 不涉及。 取值范围:
|
allowed_binary_file_name_regex |
String |
参数解释: 二进制文件白名单(可直接入库的文件)。 |
author_regex |
AnyType |
参数解释: 提交人。 |
updated_at |
String |
参数解释: 更新时间。 |
skip_rule_check |
Boolean |
参数解释: 是否跳过规则检测。 约束限制: 不涉及。 取值范围:
|
skip_rule_end_date |
String |
参数解释: 失效时间。 |
name |
String |
参数解释: 规则名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
branch_name |
String |
参数解释: 分支规则。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
created_at |
String |
参数解释: 创建时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Integer |
参数解释: 用户id 约束限制: 不涉及。 取值范围: 1-2147483647 |
name |
String |
参数解释: 用户名称 约束限制: 不涉及。 |
username |
String |
参数解释: 用户名 约束限制: 不涉及。 |
state |
String |
参数解释: 用户状态 约束限制: 不涉及。 |
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", "skip_rule_check" : false, "skip_rule_end_date" : "2025-06-21T01:37:54.000+08:00" } ]
状态码
状态码 |
描述 |
---|---|
200 |
仓库提交规则列表 |
错误码
请参见错误码。