获取代码组下保护分支列表 - ListGroupProtectedBranches
功能介绍
获取代码组下保护分支列表
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
当前API调用无需身份策略权限。
URI
GET /v4/groups/{group_id}/protected-branches
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
group_id |
是 |
Integer |
参数解释: 代码组id,代码组首页,Group ID后的数字Id 默认取值: 不涉及。 取值范围: 1~2147483647 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
参数解释: 偏移量,从0开始。 取值范围: 0~2147483647 默认取值: 0 |
|
limit |
否 |
Integer |
参数解释: 返回数量。 取值范围: 1~100 默认取值: 20 |
|
search |
否 |
String |
参数解释: 检索内容 约束限制: 保护分支名称 取值范围: 保护分支名称 默认取值: 不涉及 默认取值: false |
|
user_actions |
是 |
Boolean |
参数解释: 是否返回带有user_action结构的数据,user_action结构的数据为最新的结构,推荐传参为true 约束限制: true,false 取值范围: true,false 默认取值: 默认不传参 默认取值: false |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:202
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
[数组元素] |
Array of GroupProtectedBranchApiDto objects |
参数解释: 代码组下保护分支。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
Integer |
参数解释: 保护分支唯一标识。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 取值范围: 1~2147483647 |
|
name |
String |
参数解释: 保护分支名称 取值范围: 字符串长度不少于1,不超过1000。 约束限制: 不涉及 默认取值: 不涉及 |
|
actions |
Array of ProjectProtectedActionResultApiDto objects |
参数解释: 事件列表。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
namespace_id |
Integer |
参数解释: 代码组id。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 取值范围: 1~2147483647 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
action |
String |
参数解释: 事件名称。 取值范围: 字符串长度不少于1,不超过1000。 |
|
enable |
Boolean |
参数解释: 是否启用。 |
|
users |
Array of UserBasicDto objects |
参数解释: 用户列表。 |
|
user_teams |
Array of UserTeamBasicDto objects |
参数解释: 成员组列表。 |
|
roles |
Array of RoleBasicDto objects |
参数解释: 角色列表。 |
|
addition_switchers |
Array of ForceActionEnableDto objects |
参数解释: 操作选择列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
Integer |
参数解释: 用户id。 取值范围: 1~2147483647 |
|
name |
String |
参数解释: 用户名称。 |
|
username |
String |
参数解释: 用户名。 |
|
state |
String |
参数解释: 用户状态。 取值范围: |
|
service_license_status |
Integer |
服务级权限状态 0:停用 1:启用 |
|
avatar_url |
String |
用户头像url |
|
avatar_path |
String |
用户头像路径 |
|
|
String |
用户邮箱 |
|
name_cn |
String |
用户中文名称 |
|
web_url |
String |
用户个人首页 |
|
nick_name |
String |
用户昵称 |
|
tenant_name |
String |
租户名称 |
|
error_message |
String |
参数解释: 部分查询接口校验到传参里的用户权限不足或不存在时,返回该用户但该字段不为空用于提示。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
Integer |
参数解释: 用户组ID。 取值范围: 1-2147483647 |
|
name |
String |
参数解释: 用户组名称。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
Integer |
参数解释: 角色唯一标识。 取值范围: 1~2147483647 |
|
name |
String |
参数解释: 角色名称。 取值范围: 字符串长度不少于1,不超过1000。 |
|
related_role_id |
String |
参数解释: 角色id。 取值范围: 字符串长度不少于1,不超过1000。 |
|
chinese_name |
String |
参数解释: 角色中文名称。 取值范围: 字符串长度不少于1,不超过1000。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
参数解释: 强制操作名称。 取值范围: 字符串长度不少于1,不超过1000。 |
|
enable |
Boolean |
参数解释: 强制操作是否开启。 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码。 |
|
error_msg |
String |
参数解释: 错误信息。 |
状态码:403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码。 |
|
error_msg |
String |
参数解释: 错误信息。 |
请求示例
GET https://{endpoint}/v4/groups/{group_id}/protected-branches
响应示例
状态码:202
获取代码组下保护分支列表
[ {
"id" : 250,
"name" : 3,
"namespace_id" : 2111955766,
"actions" : [ {
"action" : "push",
"enable" : true,
"users" : [ ],
"user_teams" : [ ],
"roles" : [ ],
"addition_switchers" : [ {
"name" : "allowed_force_push",
"enable" : false
} ]
}, {
"action" : "merge",
"enable" : false,
"users" : null,
"user_teams" : null,
"roles" : null,
"addition_switchers" : null
} ]
} ]
状态码:401
Unauthorized
{
"error_code" : "DEV.00000003",
"error_msg" : "认证信息过期"
}
状态码:403
Bad Request
{
"error_code" : "CH.004403",
"error_msg" : "您没有操作权限,请升级权限后重试。"
}
状态码
|
状态码 |
描述 |
|---|---|
|
202 |
获取代码组下保护分支列表 |
|
401 |
Unauthorized |
|
403 |
Bad Request |
错误码
请参见错误码。