获取代码组下的子代码组和仓库列表
功能介绍
获取代码组下的子代码组和仓库列表
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v4/groups/{group_id}/subgroups-and-repositories
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
group_id |
是 |
Integer |
参数解释: 代码组id,代码组首页,Group ID后的数字Id 取值范围: 1-2147483647 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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/groups/{group_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" : "您没有操作权限,请升级权限后重试。" }
SDK代码示例
SDK代码示例如下。
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.codehub.v4.region.CodeHubRegion; import com.huaweicloud.sdk.codehub.v4.*; import com.huaweicloud.sdk.codehub.v4.model.*; public class ListGroupSubgroupsAndRepositoriesSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); CodeHubClient client = CodeHubClient.newBuilder() .withCredential(auth) .withRegion(CodeHubRegion.valueOf("<YOUR REGION>")) .build(); ListGroupSubgroupsAndRepositoriesRequest request = new ListGroupSubgroupsAndRepositoriesRequest(); request.withGroupId({group_id}); try { ListGroupSubgroupsAndRepositoriesResponse response = client.listGroupSubgroupsAndRepositories(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodehub.v4.region.codehub_region import CodeHubRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodehub.v4 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = CodeHubClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeHubRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListGroupSubgroupsAndRepositoriesRequest() request.group_id = {group_id} response = client.list_group_subgroups_and_repositories(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codehub "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v4" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v4/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v4/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := codehub.NewCodeHubClient( codehub.CodeHubClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListGroupSubgroupsAndRepositoriesRequest{} request.GroupId = int32({group_id}) response, err := client.ListGroupSubgroupsAndRepositories(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
获取代码组下的子代码组和仓库列表 |
401 |
Unauthorized |
403 |
Bad Request |
错误码
请参见错误码。