获取代码组的继承设置
功能介绍
获取代码组的继承设置
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v4/groups/{group_id}/inherit
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
group_id |
是 |
Integer |
参数解释: 代码组id,代码组首页,Group ID后的数字Id 取值范围: 1-2147483647 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
setting_type |
否 |
String |
参数解释: 设置类型protected_branches保护分支 protected_tags保护tag push_rules推送规则 merge_requests合并请求 mr_branch_policies合并分支 reviews检视意见 e2e_settings e2e设置 webhook_settings hook设置 deploy_keys 部署key watermark水印 repository_settings仓库设置。 枚举值:
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:202
参数 |
参数类型 |
描述 |
---|---|---|
group_id |
String |
参数解释: 代码组id。 取值范围: 字符串长度不少于1,不超过1000。 |
source_setting |
String |
参数解释: 资源类型设置。 取值范围: 字符串长度不少于1,不超过1000。 |
project_id |
String |
参数解释: 项目id。 取值范围: 字符串长度不少于1,不超过1000。 |
upward_inherit_editable |
Boolean |
参数解释: 向上继承是否可编辑。 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
请求示例
GET https://{endpoint}/v4/groups/{group_id}/inherit?offset=0&limit=20
响应示例
状态码:202
获取代码组的继承设置
{ "group_id" : 2111919928, "source_setting" : "group", "project_id" : "c65b44ca43b04961860e728cb91acfc6", "upward_inherit_editable" : true }
状态码:401
Unauthorized
{ "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }
状态码:403
Bad Request
{ "error_code" : "CH.004403", "error_msg" : "您没有操作权限,请升级权限后重试。" }
状态码
状态码 |
描述 |
---|---|
202 |
获取代码组的继承设置 |
401 |
Unauthorized |
403 |
Bad Request |
错误码
请参见错误码。