Help Center/ CodeArts Artifact/ API Reference/ API/ Repository Details/ Collecting Number of Artifacts in Repository When Querying Details about Repository
Updated on 2026-01-22 GMT+08:00

Collecting Number of Artifacts in Repository When Querying Details about Repository

Function

This API is used to collect the number of artifacts in the repository when querying details about a repository.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartsartifact:repository:read

Read

-

-

-

-

URI

GET /cloudartifact/v5/{tenant_id}/{project_id}/{repo_id}/repositories

Table 1 Path Parameters

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.

Range

N/A.

Default value

None

project_id

Yes

String

Definition

Project ID, which 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 contains 32 characters. Only letters and digits are supported.

Range

N/A.

Default value

None

repo_id

Yes

String

Definition

Repository ID. The format is {region}{domainId}{format}_{sequence}. You can find the repository ID on the general page of your self-hosted repos. It is the string located between the last two slashes (/) in the repository URL.

Constraints

The region and domainId in the repository ID must be valid values. The valid values of format are npm, go, pypi, rpm, composer, maven, debian, conan, nuget, docker2, cocoapods, and ohpm. The upper limit of sequence varies depending on the package.

Range

N/A.

Default value

None

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

region

Yes

String

Definition

Area.

Constraints

N/A.

Range

N/A.

Default value

None

path

No

String

Definition

Query path.

Constraints

Maximum length: 1,280

Range

N/A.

Default value

None

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

status

String

Definition

Request status.

Range

success: The request is successful.

error: The request fails.

trace_id

String

Definition

Request ID, which uniquely identifies the current request.

Range

A string of digits and hyphens (-).

result

RepositoryBasicDO object

Definition

Repository details.

Range

N/A.

Table 4 RepositoryBasicDO

Parameter

Type

Description

id

String

Definition

id.

Range

N/A.

status

String

Definition

Repository status.

Range

active: Normal.

delete: Deleted.

disabled: Invalid.

view: Viewer of self-hosted repos.

trash: Deprecated.

domainId

String

Definition

Tenant ID.

Range

N/A.

region

String

Definition

Area.

Range

N/A.

createdTime

String

Definition

Creation time, in yyyy-MM-dd HH:mm:ss format.

Range

N/A.

modifiedTime

String

Definition

Modification time, in yyyy-MM-dd HH:mm:ss format.

Range

N/A.

createdUserId

String

Definition

Creator ID.

Range

N/A.

createdUserName

String

Definition

Creator name.

Range

N/A.

modifiedUserId

String

Definition

Modifier ID.

Range

N/A.

modifiedUserName

String

Definition

Modifier name.

Range

N/A.

name

String

Definition

Repository ID.

Range

N/A.

disable

Boolean

Definition

Disabled or not.

Range

N/A.

format

String

Definition

Package type.

Range

maven, maven2, npm, go, pypi, rpm, composer, debian, conan, nuget, docker2, cocoapods, ohpm, generic, helm, conda, and huggingfaceml.

repoType

String

Definition

Repository type.

Range

hosted: local repository

remote: proxy repository

virtual: virtual repository

policy

String

Definition

Repository policies.

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.

Range

N/A.

repositoryName

String

Definition

Repository name.

Range

N/A.

displayName

String

Definition

Repository name displayed.

Range

N/A.

description

String

Definition

Repository description.

Range

N/A.

projectId

String

Definition

Project ID.

Range

N/A.

includesPattern

String

Definition

Include Patterns.

Range

N/A.

deploymentPolicy

String

Definition

Deployment policies.

Range

N/A.

shareRight

String

Definition

Shared permissions.

Range

PROJECT

url

String

Definition

Repository URL.

Range

N/A.

packageType

String

Definition

Package type.

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.

Range

N/A.

Table 5 DownloadFolderInfo

Parameter

Type

Description

filesCount

Long

Definition

Total number of files.

Range

N/A.

usedSpace

String

Definition

Occupied space.

Range

N/A.

Example Requests

This API is used to collect the number of artifacts in the repository when querying details about a repository.

https://artifact.example-1.myhuaweicloud.com/cloudartifact/v5/5a775fdcb14f4431b6c0015618140bc3/035a1e9da3074adfb57acd1da494d736/xx-xxxxx-x_5a775fdcb14f4431b6c0015618140bc3_conan_8/repositories?region=xx-xxxxx-x

Example Responses

Status code: 200

OK

{
  "status" : "success",
  "trace_id" : "143002-1701221877267-423",
  "result" : {
    "id" : null,
    "name" : "xx-xxxxx-x_5a775fdcb14f4431b6c0015618140bc3_conan_8",
    "description" : "",
    "createdTime" : "2023-10-27 15:48:54",
    "createdUserId" : "e9253deb37654775bb3c411aca89153a",
    "createdUserName" : "devcloud_devcloud_y00226182_01",
    "modifiedTime" : "2023-11-02 20:08:14",
    "modifiedUserId" : "e9253deb37654775bb3c411aca89153a",
    "modifiedUserName" : "devcloud_devcloud_y00226182_01",
    "format" : "conan",
    "repoType" : "hosted",
    "includesPattern" : "**/*",
    "url" : null,
    "storageSummaryInfo" : {
      "filesCount" : 0,
      "usedSpace" : "0 MB"
    },
    "projectId" : "035a1e9da3074adfb57acd1da494d736",
    "shareRight" : "PROJECT",
    "deploymentPolicy" : null,
    "repositoryName" : "conan7",
    "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
48
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 ShowRepositorySolution {

    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();
        ShowRepositoryRequest request = new ShowRepositoryRequest();
        request.withTenantId("{tenant_id}");
        request.withProjectId("{project_id}");
        request.withRepoId("{repo_id}");
        try {
            ShowRepositoryResponse response = client.showRepository(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
33
# 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 = ShowRepositoryRequest()
        request.tenant_id = "{tenant_id}"
        request.project_id = "{project_id}"
        request.repo_id = "{repo_id}"
        response = client.show_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
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.ShowRepositoryRequest{}
	request.TenantId = "{tenant_id}"
	request.ProjectId = "{project_id}"
	request.RepoId = "{repo_id}"
	response, err := client.ShowRepository(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.