文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ Repository/ 查看仓库通用策略
更新时间：2025-08-20 GMT+08:00
查看PDF
分享

查看仓库通用策略

功能介绍

查看仓库通用策略

调试

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

URI

GET /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万。

默认取值：

不涉及。

响应参数

状态码：200

表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_users

Array of PushRuleDevelopersDto objects

参数解释：

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

参数

参数类型

描述

id

AnyType

参数解释：

主键ID。

取值范围：

1-2147483647

user_id

AnyType

参数解释：

用户ID。

取值范围：

1-2147483647

user_name

AnyType

参数解释：

用户名。

nick_name

String

参数解释：

昵称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

tenant_name

String

参数解释：

租户名。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求示例

无

响应示例

状态码：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"
  } ]
}

状态码

状态码

描述

200

仓库通用策略

错误码

请参见错误码。

父主题： Repository

相关文档