查询项目列表 - ShowProjectRelatedRepository
功能介绍
调用该接口可以快速查询项目列表信息,包含仓库和项目的关联关系,以便于仓库的管理和协作。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| codeartsartifact:repository:read | Read | - | - | - | - |
URI
GET /v5/maven/project/repository
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| search_name | 否 | String | 参数解释: 项目名称,支持模糊查询。 约束限制: 不涉及。 取值范围: 最大200个字符。 默认取值: 不涉及。 |
| offset | 否 | Integer | 参数解释: 分页查询的起始位置。 约束限制: 不涉及。 取值范围: 0-2147483647 默认取值: 0 |
| limit | 否 | Integer | 参数解释: 分页查询每页的数据量。 约束限制: 不涉及。 取值范围: 1-2147483647 默认取值: 10 |
| repo_id | 否 | String | 参数解释: 仓库id,格式为{region}_{domainId}_{format}_{sequence}。使用查询仓库详情,不会去统计仓库下的制品数量接口的响应体中"name"参数的值作为此参数的值。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| x-auth-token | 是 | String | 参数解释: 用户token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值),调用详情请参考章节。 约束限制: 不涉及。 取值范围: 字符串长度为1-100000。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 查询项目列表成功或失败的状态。 取值范围: |
| trace_id | String | 参数解释: 请求ID,当前请求的唯一标识。 取值范围: 数字及中划线(-)组成的字符串。 |
| result | PrivilegeProjectInfoV5 object | 参数解释: 请求返回的结果,项目对象。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 项目的序号。 取值范围: 不涉及。 |
| name | String | 参数解释: 项目的名称。 取值范围: 不涉及。 |
| status | String | 参数解释: 项目的状态(该参数无返回值,请忽略)。 取值范围: 该参数无返回值,请忽略。 |
| project_id | String | 参数解释: 项目ID。 取值范围: 不涉及。 |
| created_time | String | 参数解释: 项目的创建时间。 取值范围: 格式为yyyy-MM-dd HH:mm:ss。 |
| repository_num | Integer | 参数解释: 仓库数量。 取值范围: 不涉及。 |
| total | Integer | 参数解释: 项目总数(该参数无返回值,请忽略)。 取值范围: 该参数无返回值,请忽略。 |
| repository_id | String | 参数解释: 仓库ID。 取值范围: 不涉及。 |
| region | String | 参数解释: 项目所属的区域。 取值范围: 不涉及。 |
| domain_id | String | 参数解释: 租户ID。 取值范围: 不涉及。 |
| ids | Array of strings | 参数解释: 项目的序号列表(该参数无返回值,请忽略)。 取值范围: 该参数无返回值,请忽略。 |
| total_records | Integer | 参数解释: 项目总数。 取值范围: 不涉及。 |
| associated | Boolean | 参数解释: 请求参数中的仓库ID是否关联到本项目。 取值范围: |
| project_info | Array of PrivilegeProjectInfoV5 objects | 参数解释: 项目的信息。 取值范围: 不涉及。 |
请求示例
查询项目列表。
https://artifact.example-1.com/v5/maven/project/repository?search_name=子用户删除测试&repo_id=aa-bbbbb-c_09d2ca2f5080d5b60f51c00ae5bad0a0_maven_5_44&offset=0&limit=10
响应示例
状态码:200
查询项目管理对接列表成功。
{
"status" : "success",
"trace_id" : "143006-1760344958153-39922",
"result" : {
"id" : null,
"name" : null,
"status" : null,
"total" : 1,
"region" : null,
"ids" : null,
"associated" : false,
"project_id" : null,
"created_time" : null,
"repository_num" : 0,
"repository_id" : null,
"domain_id" : null,
"project_info" : [ {
"id" : null,
"name" : "子用户删除测试",
"status" : null,
"total" : 0,
"region" : null,
"ids" : null,
"associated" : false,
"project_id" : "b6c5c65138f24847acc3acaae9d009d8",
"created_time" : "2025-08-27 16:56:11",
"repository_num" : 1,
"repository_id" : null,
"domain_id" : null,
"project_info" : null,
"total_records" : 0
} ],
"total_records" : 1
}
} 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 | 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.codeartsartifact.v2.region.CodeArtsArtifactRegion; import com.huaweicloud.sdk.codeartsartifact.v2.*; import com.huaweicloud.sdk.codeartsartifact.v2.model.*; public class ShowProjectRelatedRepositorySolution { 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); CodeArtsArtifactClient client = CodeArtsArtifactClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsArtifactRegion.valueOf("<YOUR REGION>")) .build(); ShowProjectRelatedRepositoryRequest request = new ShowProjectRelatedRepositoryRequest(); try { ShowProjectRelatedRepositoryResponse response = client.showProjectRelatedRepository(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 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodeartsartifact.v2.region.codeartsartifact_region import CodeArtsArtifactRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartsartifact.v2 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 = CodeArtsArtifactClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsArtifactRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowProjectRelatedRepositoryRequest() response = client.show_project_related_repository(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 37 38 39 40 41 42 43 44 45 46 47 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codeartsartifact "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsartifact/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsartifact/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsartifact/v2/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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := codeartsartifact.CodeArtsArtifactClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := codeartsartifact.NewCodeArtsArtifactClient(hcClient) request := &model.ShowProjectRelatedRepositoryRequest{} response, err := client.ShowProjectRelatedRepository(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询项目管理对接列表成功。 |
错误码
请参见错误码。