获取代码组列表
功能介绍
获取代码组列表
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v4/groups/list
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
search |
否 |
String |
参数解释: 检索内容 默认取值: false |
all_available |
否 |
Boolean |
参数解释: 所有可用的代码组。 |
order_by |
否 |
String |
参数解释: 排序字段,name 名称 path 路径 id 唯一标示 created_at 创建时间 updated_at 更新时间 默认取值: created_at 枚举值:
|
sort |
否 |
String |
参数解释: 排序顺序 asc顺序 desc逆序 默认取值: desc 枚举值:
|
starred |
否 |
Boolean |
参数解释: 是否关注。 默认取值: false |
offset |
否 |
Integer |
参数解释: 偏移量,从0开始。 取值范围: 0-2147483647 默认取值: 0 |
limit |
否 |
Integer |
参数解释: 返回数量。 取值范围: 1-100 默认取值: 20 |
owned |
否 |
Boolean |
参数解释: |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
[数组元素] |
Array of GroupBaseDto objects |
参数解释: 代码组列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
project_id |
String |
参数解释: 项目id。 取值范围: 字符串长度不少于1,不超过1000。 |
project_name |
String |
参数解释: 项目名称。 取值范围: 字符串长度不少于1,不超过1000。 |
ancestor_ids |
Array of integers |
参数解释: 代码组id。 取值范围: 1-2147483647 |
ancestor_names |
Array of strings |
参数解释: 代码组名称。 |
develop_mode |
String |
参数解释: 开发模式,normal,cr。 取值范围: 字符串长度不少于1,不超过1000。 |
id |
Integer |
参数解释: 记录id。 取值范围: 1-2147483647 |
name |
String |
参数解释: 名称。 取值范围: 字符串长度不少于1,不超过1000。 |
path |
String |
参数解释: 路径。 取值范围: 字符串长度不少于1,不超过1000。 |
group_level |
Integer |
参数解释: 代码组层级。 取值范围: 1-2147483647 |
description |
String |
参数解释: 描述。 取值范围: 字符串长度不少于1,不超过1000。 |
subgroup_count |
Integer |
参数解释: 子代码组数量。 取值范围: 1-2147483647 |
project_count |
Integer |
参数解释: 仓库数量。 取值范围: 1-2147483647 |
group_role |
Integer |
参数解释: 代码组角色。 取值范围: 1-2147483647 |
group_members_count |
Integer |
参数解释: 代码组成员数量。 取值范围: 1-2147483647 |
descendant_type |
String |
参数解释: 类型。 取值范围: 字符串长度不少于1,不超过1000。 |
visibility_level |
Integer |
参数解释: 可见性 0 20。 取值范围: 1-2147483647 |
visibility |
String |
参数解释: 可见性 private public。 取值范围: 字符串长度不少于1,不超过1000。 |
is_project_admin |
Integer |
参数解释: 是否为项目创建者。 取值范围: 1-2147483647 |
is_group_creator |
Integer |
参数解释: 是否为代码组创建者。 取值范围: 1-2147483647 默认取值: 0 |
is_repo_creator |
Integer |
参数解释: 是否为仓库创建者。 取值范围: 1-2147483647 |
lfs_enabled |
Boolean |
参数解释: lfs是否开启。 |
full_name |
String |
参数解释: 全名称。 取值范围: 字符串长度不少于1,不超过1000。 |
full_path |
String |
参数解释: 全路径。 取值范围: 字符串长度不少于1,不超过1000。 |
item_type |
String |
参数解释: item类型。 取值范围: 字符串长度不少于1,不超过1000。 |
parent_id |
Integer |
参数解释: 父代码组id。 取值范围: 1-2147483647 |
my_role |
GroupMyRoleDtoV4 object |
参数解释: 我的角色。 |
members |
Integer |
参数解释: 成员。 取值范围: 1-2147483647 |
web_url |
String |
参数解释: url地址。 取值范围: 字符串长度不少于1,不超过1000。 |
created_at |
String |
参数解释: 创建时间。 取值范围: 字符串长度不少于1,不超过1000。 |
sub_group_count |
Integer |
参数解释: 子代码组数量。 取值范围: 1-2147483647 |
last_owner |
Boolean |
参数解释: 是否为最后所有者。 |
starred |
Boolean |
参数解释: 是否关注。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Integer |
参数解释: 记录id。 取值范围: 1-2147483647 |
access_level |
Integer |
参数解释: 角色。 取值范围: 1-2147483647 |
role_namecn |
String |
参数解释: 角色中文名称。 取值范围: 字符串长度不少于1,不超过1000。 |
role_namen |
String |
参数解释: 角色英文名称。 取值范围: 字符串长度不少于1,不超过1000。 |
source_id |
Integer |
参数解释: 资源id。 取值范围: 1-2147483647 |
source_type |
String |
参数解释: 资源类型。 取值范围:Group Project 字符串长度不少于1,不超过1000。 |
user_id |
Integer |
参数解释: 用户id。 取值范围: 1-2147483647 |
notification_level |
Integer |
参数解释: 通知。 取值范围: 1-2147483647 |
created_at |
String |
参数解释: 创建时间。 取值范围: 字符串长度不少于1,不超过1000。 |
updated_at |
String |
参数解释: 更新时间。 取值范围: 字符串长度不少于1,不超过1000。 |
is_project_admin |
Integer |
参数解释: 是否是项目创建者。 取值范围: 1-2147483647 |
is_group_creator |
Integer |
参数解释: 是否是代码组创建者。 取值范围: 1-2147483647 |
is_repo_creator |
Integer |
参数解释: 是否是仓库创建者。 取值范围: 1-2147483647 |
role_show_flag |
Integer |
参数解释: 角色展示。 取值范围: 1-2147483647 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
请求示例
GET https://{endpoint}/v4/groups/list
响应示例
状态码:200
获取代码组列表
[ { "project_id" : "c65b44ca43b04961860e728cb91acfc6", "project_name" : "Scrum_ltest_sync", "ancestor_ids" : [ 2111921555 ], "ancestor_names" : [ "te" ], "develop_mode" : "normal", "id" : 2111921555, "name" : "te", "web_url" : null, "lfs_enabled" : true, "full_name" : "te", "full_path" : "te", "path" : "te", "visibility" : "public", "description" : null, "item_type" : "Group", "parent_id" : 2111919908, "my_role" : { "id" : 1084102, "access_level" : 50, "role_namecn" : "项目管理员", "role_namen" : "project_admin", "source_id" : 2111921555, "source_type" : "Namespace", "user_id" : 7574, "notification_level" : 3, "created_at" : "2025-06-20T22:32:56.000+08:00", "updated_at" : "2025-06-20T22:32:56.000+08:00", "is_project_admin" : 1, "is_group_creator" : 1, "is_repo_creator" : 0, "role_show_flag" : 6 }, "members" : 2, "created_at" : "2025-06-20T22:32:56.000+08:00", "project_count" : 0, "sub_group_count" : 0, "last_owner" : true, "starred" : false } ]
状态码:401
Unauthorized
{ "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }
状态码:403
Bad Request
{ "error_code" : "CH.004403", "error_msg" : "您没有操作权限,请升级权限后重试。" }
状态码
状态码 |
描述 |
---|---|
200 |
获取代码组列表 |
401 |
Unauthorized |
403 |
Bad Request |
错误码
请参见错误码。