获取项目下的代码组和仓库列表
功能介绍
获取项目下的代码组和仓库列表
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v4/projects/{project_id}/subgroups-and-repositories
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口查询项目列表获取。 取值范围: 字符串长度32。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
filter |
否 |
Integer |
参数解释: 检索条件,名称。 取值范围: 1-2147483647 |
order_by |
否 |
String |
参数解释: 排序字段 id 唯一标识 name 名称 created_at 创建时间 updated_at 更新时间 默认取值: updated_at 枚举值:
|
sort |
否 |
String |
参数解释: 排序顺序 asc顺序 desc逆序 默认取值: desc 枚举值:
|
archived |
否 |
Boolean |
参数解释: 是否归档 默认取值: false |
offset |
否 |
Integer |
参数解释: 偏移量,从0开始。 取值范围: 0-2147483647 默认取值: 0 |
limit |
否 |
Integer |
参数解释: 返回数量。 取值范围: 1-100 默认取值: 20 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
[数组元素] |
Array of SubgroupAndProjectBaseDto objects |
参数解释: 项目下代码组和仓库列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
project_id |
String |
参数解释: 项目id。 取值范围: 字符串长度不少于1,不超过1000。 |
project_name |
String |
参数解释: 项目名称。 取值范围: 字符串长度不少于1,不超过1000。 |
role_namecn |
String |
参数解释: 角色中文名称。 取值范围: 字符串长度不少于1,不超过1000。 |
role_nameen |
String |
参数解释: 角色英文名称。 取值范围: 字符串长度不少于1,不超过1000。 |
full_name |
String |
参数解释: 全名称。 取值范围: 字符串长度不少于1,不超过1000。 |
full_path |
String |
参数解释: 全路径。 取值范围: 字符串长度不少于1,不超过1000。 |
created_at |
String |
参数解释: 创建时间。 取值范围: 字符串长度不少于1,不超过1000。 |
updated_at_timestamp |
String |
参数解释: 更新时间戳。 取值范围: 字符串长度不少于1,不超过1000。 |
star_time |
String |
参数解释: 开始时间戳。 取值范围: 字符串长度不少于1,不超过1000。 |
starred |
Boolean |
参数解释: 是否收藏。 |
develop_mode |
String |
参数解释: 开发模式,cr,"normal"。 取值范围: 字符串长度不少于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 |
参数解释: 资源类型 group,project。 取值范围: 字符串长度不少于1,不超过1000。 |
visibility_level |
Integer |
参数解释: 可见性level 0(私有),20(公开) 取值范围: 1-2147483647 |
visibility |
String |
参数解释: 可见性 private public。 取值范围: 字符串长度不少于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 |
uuid |
String |
参数解释: 仓库的uuid。 取值范围: 字符串长度不少于1,不超过1000。 |
forks_count |
Integer |
参数解释: fork数量。 取值范围: 1-2147483647 |
is_kia |
Boolean |
参数解释: 是否为kia。 |
is_owner |
Boolean |
参数解释: 是否为所有者。 |
archived |
Boolean |
参数解释: 是否为存档。 |
last_repository_updated_at |
String |
参数解释: 仓库的最后更新时间。 取值范围: 字符串长度不少于1,不超过1000。 |
open_merge_requests_count |
Integer |
参数解释: 开启的mr数量。 取值范围: 1-2147483647 |
all_merge_requests_count |
Integer |
参数解释: 所有的mr数量。 取值范围: 1-2147483647 |
project_role |
Integer |
参数解释: 仓库角色。 取值范围: 1-2147483647 |
project_members_count |
Integer |
参数解释: fork数量。 取值范围: 1-2147483647 |
project_creator |
ProjectCreatorDto object |
参数解释: 项目创建者。 |
star_count |
Integer |
参数解释: fork数量。 取值范围: 1-2147483647 |
tag_list |
Array of strings |
参数解释: tag列表。 |
http_url_to_repo |
String |
参数解释: 仓库的http url。 取值范围: 字符串长度不少于1,不超过1000。 |
ssh_url_to_repo |
String |
参数解释: 仓库的ssh url。 取值范围: 字符串长度不少于1,不超过1000。 |
status |
Integer |
参数解释: 状态。 取值范围: 1-2147483647 |
active_statistic |
Array of integers |
参数解释: 活跃统计。 取值范围: 1-2147483647 |
security_tag |
String |
参数解释: 安全标签。 取值范围: 字符串长度不少于1,不超过1000。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Integer |
参数解释: 唯一标识id。 取值范围: 1-2147483647 |
name |
String |
参数解释: 名称。 取值范围: 字符串长度不少于1,不超过1000。 |
username |
String |
参数解释: iam_id。 取值范围: 字符串长度不少于1,不超过1000。 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
请求示例
GET https://{endpoint}/v4/projects/{project_id}/subgroups-and-repositories?offset=0&limit=20
响应示例
状态码:200
获取项目下的代码组和仓库列表
[ { "project_id" : "c65b44ca43b04961860e728cb91acfc6", "project_name" : "null,项目名称", "role_namecn" : "项目管理员", "role_nameen" : "project_admin", "full_name" : "p_group3", "full_path" : "p_group3", "created_at" : "2025-06-03T22:45:31.000+08:00", "updated_at_timestamp" : 1748904331000, "star_time" : 1749955042000, "starred" : false, "develop_mode" : "normal", "id" : 2111919928, "name" : "p_group3", "path" : "p_group3", "group_level" : 1, "description" : null, "subgroup_count" : 1, "project_count" : 0, "group_role" : 50, "group_members_count" : 2, "descendant_type" : "Group", "visibility_level" : 0, "visibility" : "private", "is_project_admin" : 1, "is_group_creator" : 1, "is_repo_creator" : 0, "role_show_flag" : 6 } ]
状态码:401
Unauthorized
{ "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }
状态码:403
Bad Request
{ "error_code" : "CH.004403", "error_msg" : "您没有操作权限,请升级权限后重试。" }
状态码
状态码 |
描述 |
---|---|
200 |
获取项目下的代码组和仓库列表 |
401 |
Unauthorized |
403 |
Bad Request |
错误码
请参见错误码。