Skipping the Number of Artifacts in the Repository When Querying Repository Details
Function
Skip the number of artifacts in the repository when querying repository details.
Calling Method
For details, see Calling APIs.
URI
GET /cloudartifact/v5/{tenant_id}/{project_id}/repositories
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
tenant_id |
Yes |
String |
Definition: Tenant ID. Constraints: The value can contain 8 to 32 characters. Only letters and digits are supported. Value range: N/A Default value: None |
project_id |
Yes |
String |
Definition: Project ID. It can be obtained by calling an API or from the console. For details about how to obtain the project ID, see Obtaining a Project ID (CloudArtifact_api_0015.xml). Constraints: The value can contain 32 characters. Only letters and digits are supported. Value range: N/A Default value: None |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
group_id |
No |
String |
Definition: User group ID, which is no longer in use. Constraints: N/A Value range: N/A Default value: N/A |
page_no |
No |
Integer |
Definition: Number of pages in a pagination query. Constraints: N/A Value range: 1–2,147,483,647 Default value: 1 |
page_size |
No |
Integer |
Definition: Number of records on each page during the pagination query. Constraints: N/A Value range: 1–100 Default value: 10 |
sort |
No |
String |
Definition: Sorting type, which is no longer in use. Constraints: N/A Value range: N/A Default value: N/A |
qname |
No |
String |
Definition: Query content. Constraints: A string of 1 to 50 characters. Value range: N/A Default value: N/A |
type |
No |
String |
Definition: Repository type. Constraints: N/A Value range: hosted, local, virtual, remote, and proxy. Default value: N/A |
format |
No |
String |
Definition: Package type. Only one type can be specified. Constraints: N/A Value range: maven2, docker, conan, debian, go, nuget, rpm, pypi, npm, cocoapods, and generic. Default value: N/A |
format_list |
No |
String |
Definition: Package types. You can specify multiple types. Use commas (,) to separate them. Constraints: N/A Value range: maven2, docker, conan, debian, go, nuget, rpm, pypi, npm, cocoapods, and generic. Default value: N/A |
is_recycle_bin |
No |
Boolean |
Definition: Whether the repository is in the recycle bin. Constraints: N/A Value range: true: query the repositories in the recycle bin. false: query repositories in the active state. Default value: N/A |
is_need_paging |
No |
Boolean |
Definition: Pagination required or not. Constraints: N/A Value range: true: Pagination is required. false: Pagination is not required. Default value: N/A |
in_project |
No |
Boolean |
Whether it is in project or not. Constraints: N/A Value range: true: in the project. false: not in the project. Default value: N/A |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
status |
String |
Definition: Request status. Value range: success: The request is successful. error: The request fails. |
trace_id |
String |
Definition: Request ID, which uniquely identifies the current request. Value range: A string of digits and hyphens (-). |
result |
ListAllRepositoriesResult object |
Definition: Repository details. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
total |
Integer |
Definition: Total number. Value range: N/A |
repositories |
Array of RepositoryBasicDO objects |
Definition: Repository details list. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition: ID. Value range: N/A |
status |
String |
Definition: Repository status. Value range: active: Normal. delete: Deleted. disabled: Invalid. view: Viewer of self-hosted repos. trash: Deprecated. |
domainId |
String |
Definition: Tenant ID. Value range: N/A |
region |
String |
Definition: Region. Value range: N/A |
createdTime |
String |
Definition: Creation time, in yyyy-MM-dd HH:mm:ss format. Value range: N/A |
modifiedTime |
String |
Definition: Modification time, in yyyy-MM-dd HH:mm:ss format. Value range: N/A |
createdUserId |
String |
Definition: Creator ID. Value range: N/A |
createdUserName |
String |
Definition: Creator name. Value range: N/A |
modifiedUserId |
String |
Definition: Modifier ID. Value range: N/A |
modifiedUserName |
String |
Definition: Modifier name. Value range: N/A |
name |
String |
Definition: Repository ID. Value range: N/A |
disable |
Boolean |
Definition: Disabled or not. Value range: N/A |
format |
String |
Definition: Package type. Value range: maven, maven2, npm, go, pypi, rpm, composer, debian, conan, nuget, docker2, cocoapods, ohpm, generic, helm, conda, and huggingfaceml. |
repoType |
String |
Definition: Repository type. Value range: hosted: local repository remote: proxy repository virtual: virtual repository |
policy |
String |
Definition: Repository policies. Value range: release or snapshot |
tabId |
String |
Definition: tab_id is used to identify a pair of Maven repositories (Release and Snapshot). A tab_id indicates a pair of Maven repositories. Value range: N/A |
repositoryName |
String |
Definition: Repository name. Value range: N/A |
displayName |
String |
Definition: Repository name displayed. Value range: N/A |
description |
String |
Definition: Repository description. Value range: N/A |
projectId |
String |
Definition: Project ID. Value range: N/A |
includesPattern |
String |
Definition: Include patterns. Value range: N/A |
deploymentPolicy |
String |
Definition: Deployment policies. Value range: N/A |
shareRight |
String |
Definition: Shared permission. Value range: PROJECT |
url |
String |
Definition: Repository URL. Value range: N/A |
packageType |
String |
Definition: Package type. Value range: maven, maven2, npm, go, pypi, rpm, composer, debian, conan, nuget, docker2, cocoapods, ohpm, generic, helm, conda, and huggingfaceml. |
storageSummaryInfo |
DownloadFolderInfo object |
Definition: Storage information. Value range: N/A |
Example Requests
Skip the number of artifacts in the repository when querying repository details.
https://artifact.cn-south-1.myhuaweicloud.com/cloudartifact/v5/00000000000000000000000000000000/00000000000000000000000000000000/repositories?in_project=true&format=&page_no=1&page_size=2&qname=&format_list=maven2,npm,go,pypi,rpm,debian,conan,nuget,docker&is_need_paging=true
Example Responses
Status code: 200
OK
{ "status" : "success", "trace_id" : "143006-1701221592150-283", "result" : { "total" : 183, "repositories" : [ { "id" : null, "name" : "xx-xxxxx-x_5a775fdcb14f4431b6c0015618140bc3_conan_5", "description" : "1,0", "createdTime" : "2022-08-22 17:14:55", "createdUserId" : "e9253deb37654775bb3c411aca89153a", "createdUserName" : "devcloud_devcloud_y00226182_01", "modifiedTime" : "2023-10-16 20:05:59", "modifiedUserId" : "e9253deb37654775bb3c411aca89153a", "modifiedUserName" : "devcloud_devcloud_y00226182_01", "format" : "conan", "repoType" : "hosted", "includesPattern" : "**/*", "url" : "https://devrepo.devcloud.xx-xxxxx-x.xxxxxxx.huawei.com/artgalaxy/api/conan/xx-xxxxx-x_5a775fdcb14f4431b6c0015618140bc3_conan_5/", "storageSummaryInfo" : null, "projectId" : null, "shareRight" : null, "deploymentPolicy" : null, "repositoryName" : "5465653", "displayName" : null, "policy" : null, "tabId" : null, "status" : "active", "domainId" : "5a775fdcb14f4431b6c0015618140bc3", "region" : "xx-xxxxx-x", "uri" : null, "disable" : false, "packageType" : "conan" }, { "id" : null, "name" : "xx-xxxxx-x_5a775fdcb14f4431b6c0015618140bc3_conan_6", "description" : "", "createdTime" : "2022-08-22 17:21:15", "createdUserId" : "e9253deb37654775bb3c411aca89153a", "createdUserName" : "devcloud_devcloud_y00226182_01", "modifiedTime" : "2023-10-16 20:05:59", "modifiedUserId" : null, "modifiedUserName" : "devcloud_devcloud_y00226182_01", "format" : "conan", "repoType" : "hosted", "includesPattern" : "**/*", "url" : "https://devrepo.devcloud.xx-xxxxx-x.xxxxxxx.huawei.com/artgalaxy/api/conan/xx-xxxxx-x_5a775fdcb14f4431b6c0015618140bc3_conan_6/", "storageSummaryInfo" : null, "projectId" : null, "shareRight" : null, "deploymentPolicy" : null, "repositoryName" : "12321", "displayName" : null, "policy" : null, "tabId" : null, "status" : "active", "domainId" : "5a775fdcb14f4431b6c0015618140bc3", "region" : "xx-xxxxx-x", "uri" : null, "disable" : false, "packageType" : "conan" } ] } }
SDK Sample Code
The SDK sample code is as follows.
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 47 |
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 ListAllRepositoriesSolution { 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(); ListAllRepositoriesRequest request = new ListAllRepositoriesRequest(); request.withTenantId("{tenant_id}"); request.withProjectId("{project_id}"); try { ListAllRepositoriesResponse response = client.listAllRepositories(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 32 |
# 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 = ListAllRepositoriesRequest() request.tenant_id = "{tenant_id}" request.project_id = "{project_id}" response = client.list_all_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 37 |
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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := codeartsartifact.NewCodeArtsArtifactClient( codeartsartifact.CodeArtsArtifactClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListAllRepositoriesRequest{} request.TenantId = "{tenant_id}" request.ProjectId = "{project_id}" response, err := client.ListAllRepositories(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot