Updated on 2026-01-22 GMT+08:00

Viewing Repository Information

Function

This API is used to view repository information.

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/repositories/{repo_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

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

N/A.

Range

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.

Default value

N/A.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 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

RepositoryDO object

Definition

Repository information.

Range

N/A.

Table 3 RepositoryDO

Parameter

Type

Description

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.

type

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.

snapshot

String

Definition

Snapshot repository name. Either Release or Snapshot or both must be selected.

Range

N/A.

release

String

Definition

Release repository name. Either Release or Snapshot or both must be selected.

Range

N/A.

npm

String

Definition

npm.

Range

N/A.

snapshotStatus

String

Definition

Snapshot repository status.

Range

N/A.

releaseStatus

String

Definition

Release repository status.

Range

N/A.

projectId

String

Definition

Project ID.

Range

N/A.

includesPattern

String

Definition

Include Patterns.

Range

N/A.

repositoryIds

Array of strings

Definition

Repository ID list.

Range

N/A.

uri

String

Definition

URI.

Range

N/A.

deploymentPolicy

String

Definition

Deployment policies.

Range

N/A.

repositories

Array of strings

Definition

Repository list.

Range

N/A.

parentRepoName

String

Definition

Parent repository name.

Range

N/A.

userName

String

Definition

Username.

Range

N/A.

password

String

Definition

Password.

Range

N/A.

remoteUrl

String

Definition

Proxy repository address.

Range

N/A.

defaultDeployRepository

String

Definition

Default repository.

Range

N/A.

remoteType

String

Definition

Proxy repository type.

Range

public: public proxy repository

customize: custom proxy repository

proxy

String

Definition

Proxy.

Range

N/A.

allowAnonymous

Boolean

Definition

Anonymous download allowed or not.

Range

N/A.

autoCleanSnapshot

Boolean

Definition

Automatic snapshot version clearing enabled or not.

Range

N/A.

snapshotAliveDays

String

Definition

Validity period of a snapshot version, in days.

Range

N/A.

maxUniqueSnapshots

String

Definition

Max. number of snapshots.

Range

N/A.

shareRight

String

Definition

Shared permissions.

Range

PROJECT

nexuRepo

Boolean

Definition

Nexus repository or not.

Range

N/A.

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.

Example Requests

This API is used to view repository information.

https://artifact.example-1.myhuaweicloud.com/cloudartifact/v5/repositories/xx-xxxxx-x_5a775fdcb14f4431b6c0015618140bc3_maven_1_201

Example Responses

Status code: 200

OK

{
  "status" : "success",
  "trace_id" : "143002-1701175561381-82",
  "result" : {
    "status" : null,
    "domainId" : null,
    "region" : null,
    "createdTime" : null,
    "modifiedTime" : null,
    "createdUserId" : null,
    "createdUserName" : null,
    "modifiedUserId" : null,
    "modifiedUserName" : null,
    "name" : "xx-xxxxx-x_5a775fdcb14f4431b6c0015618140bc3_maven_1_201",
    "disable" : false,
    "format" : "maven2",
    "type" : "hosted",
    "policy" : null,
    "tabId" : "5a775fdcb14f4431b6c0015618140bc3_tab_maven2_201",
    "repositoryName" : "testmaven",
    "displayName" : null,
    "description" : "12",
    "snapshot" : "testmaven",
    "release" : "testmaven",
    "npm" : null,
    "snapshotStatus" : "active",
    "releaseStatus" : "active",
    "projectId" : "e2ee90487d6349dd944a5767225f6f55",
    "includesPattern" : "**/*",
    "repositoryIds" : null,
    "uri" : null,
    "deploymentPolicy" : "allowRedeploy",
    "repositories" : null,
    "parentRepoName" : null,
    "userName" : null,
    "password" : null,
    "remoteUrl" : null,
    "defaultDeployRepository" : null,
    "remoteType" : null,
    "proxy" : null,
    "allowAnonymous" : false,
    "autoCleanSnapshot" : null,
    "snapshotAliveDays" : null,
    "maxUniqueSnapshots" : "10",
    "shareRight" : "PROJECT",
    "nexuRepo" : false,
    "url" : "https://devrepo.devcloud.xx-xxxxx-x.huawei.com/artgalaxy/xx-xxxxx-x_5a775fdcb14f4431b6c0015618140bc3_maven_1_201/",
    "packageType" : "maven"
  }
}

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
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 ShowRepositoryInfoSolution {

    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();
        ShowRepositoryInfoRequest request = new ShowRepositoryInfoRequest();
        request.withRepoId("{repo_id}");
        try {
            ShowRepositoryInfoResponse response = client.showRepositoryInfo(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 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 = ShowRepositoryInfoRequest()
        request.repo_id = "{repo_id}"
        response = client.show_repository_info(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"
    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.ShowRepositoryInfoRequest{}
	request.RepoId = "{repo_id}"
	response, err := client.ShowRepositoryInfo(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.