获取指定代码组的基本设置信息
功能介绍
获取指定代码组的基本设置信息
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v4/groups/{group_id}/policies/general
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
group_id |
是 |
Integer |
参数解释: 代码组id,代码组首页,Group ID后的数字Id 取值范围: 1-2147483647 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
disable_fork |
Boolean |
参数解释: 是否禁用fork。 |
forbidden_developer_create_branch |
Boolean |
参数解释: 是否禁止开发者创建分支。 |
forbidden_developer_create_tag |
Boolean |
参数解释: 是否禁用开发者创建tag。 |
forbidden_committer_create_branch |
Boolean |
参数解释: 禁止开发者创建标签。 |
branch_name_regex |
String |
参数解释: 分支名称正则表达式。 取值范围: 字符串长度不少于1,不超过1000。 |
tag_name_regex |
String |
参数解释: 标签名正则表达式。 取值范围: 字符串长度不少于1,不超过1000。 |
generate_pre_merge_ref |
Boolean |
参数解释: 生成合并请求预合并。 |
forbidden_gitlab_access |
Boolean |
参数解释: 是否禁止repo访问。 |
rebase_disable_trigger_webhook |
Boolean |
参数解释: MR rebase是否禁止触发webhook事件。 |
open_gpg_verified |
Boolean |
参数解释: 是否开启gpg公钥验证。 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
请求示例
GET https://{endpoint}/v4/groups/{group_id}/policies/general
响应示例
状态码:200
获取指定代码组的基本设置信息
{ "disable_fork" : false, "forbidden_developer_create_branch" : false, "forbidden_developer_create_tag" : false, "forbidden_committer_create_branch" : null, "branch_name_regex" : null, "tag_name_regex" : null, "generate_pre_merge_ref" : false, "forbidden_gitlab_access" : null, "rebase_disable_trigger_webhook" : null, "open_gpg_verified" : null }
状态码:401
Unauthorized
{ "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }
状态码:403
Bad Request
{ "error_code" : "CH.004403", "error_msg" : "您没有操作权限,请升级权限后重试。" }
状态码:404
Not Found
{ "error_code" : "CH.004404", "error_msg" : "Group Not Found。Group Not Found" }
状态码
状态码 |
描述 |
---|---|
200 |
获取指定代码组的基本设置信息 |
401 |
Unauthorized |
403 |
Bad Request |
404 |
Not Found |
错误码
请参见错误码。