Help Center/ CodeArts Artifact/ API Reference/ API/ File Management/ Querying Repository File Details
Updated on 2025-09-08 GMT+08:00

Querying Repository File Details

Function

Query repository file details.

Calling Method

For details, see Calling APIs.

URI

GET /cloudartifact/v5/{tenant_id}/{project_id}/{repo_name}/file-detail

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.

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

repo_name

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

Value 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

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

path

Yes

String

Definition:

Path of the file to be queried.

Constraints:

Mandatory. The maximum length is 1,280 characters.

Value range:

N/A

Default value:

N/A

format

Yes

String

Definition:

Package type.

Constraints:

Mandatory.

Value range:

maven2, docker, conan, debian, go, nuget, rpm, pypi, npm, cocoapods, and generic.

Default value:

N/A

instance_id

No

String

Definition:

Instance ID, which is no longer in use.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

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

result object

Definition:

File details.

Value range:

N/A

Table 4 result

Parameter

Type

Description

repo

String

Definition:

Repository ID.

Value range:

N/A

path

String

Definition:

File path.

Value range:

N/A

name

String

Definition:

File name.

Value range:

N/A

created

String

Definition:

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

Value range:

N/A

createdBy

String

Definition:

Creator.

Value range:

N/A

lastModified

String

Definition:

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

Value range:

N/A

lastUpdated

String

Definition:

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

Value range:

N/A

modifiedBy

String

Definition:

Modifier.

Value range:

N/A

uri

String

Definition:

Access address.

Value range:

N/A

downloadUri

String

Definition:

Download address.

Value range:

N/A

size

String

Definition:

File size.

Value range:

N/A

attention

String

Definition:

Favorited or not.

Value range:

1: favorited

0: unfavorite

checksums

checksums object

Definition:

Checksums.

Value range:

N/A

downloadInfo

downloadInfo object

Definition:

Download information.

Value range:

N/A

gavDisplay

gavDisplay object

Definition:

Coordinates.

Value range:

N/A

originalChecksums

Object

Definition:

Checksums.

Value range:

N/A

displayName

String

Definition:

Display name.

Value range:

N/A

display_size

String

Definition:

Display size.

Value range:

N/A

Table 5 checksums

Parameter

Type

Description

sha512

String

Definition:

SHA-512 checksums.

Value range:

N/A

sha256

String

Definition:

SHA-256 checksums.

Value range:

N/A

sha1

String

Definition:

SHA-1 checksums.

Value range:

N/A

md5

String

Definition:

MD5 checksums.

Value range:

N/A

Table 6 downloadInfo

Parameter

Type

Description

uri

String

Definition:

File path.

Value range:

N/A

downloadCount

Long

Definition:

Download times.

Value range:

N/A

lastDownloaded

Long

Definition:

Last download time.

Value range:

N/A

remoteDownloadCount

Long

Definition:

Number of remote downloads.

Value range:

N/A

remoteLastDownloaded

Long

Definition:

Remote download time.

Value range:

N/A

lastDownloadedBy

String

Definition:

Last downloaded by.

Value range:

N/A

Table 7 gavDisplay

Parameter

Type

Description

gavInfo

String

Definition:

Coordinates.

Value range:

N/A

configInfo

String

Definition:

Configuration information.

Value range:

N/A

Example Requests

Query repository file details.

https://{URL}/cloudartifact/v5/00000000000000000000000000000000/11111111111111111111111111111111/xxxxx-1_xxxxxxxxxxxxxxxxxxxxxxxxx_go_1/file-detail?path=/up/up/9Hn1036zgQqL4G805Ufb43H4s1t984&format=go

Example Responses

Status code: 200

OK

{
  "status" : "success",
  "trace_id" : "143002-1701223197469-447",
  "result" : {
    "repo" : "xx-xxxxx-x_5a775fdcb14f4431b6c0015618140bc3_go_19",
    "path" : "/up/up/9Hn1036zgQqL4G805Ufb43H4s1t984",
    "name" : "9Hn1036zgQqL4G805Ufb43H4s1t984",
    "created" : "2023-11-14 19:29:46",
    "createdBy" : "devcloud_devcloud_y00226182_01",
    "lastModified" : "2023-11-14 19:29:46",
    "lastUpdated" : "2023-11-14 19:29:46",
    "modifiedBy" : "devcloud_devcloud_y00226182_01",
    "uri" : "https://cloudartifacts-backend.xx-xxxxx-x.myhuaweicloud.com/artgalaxy/api/storage/xx-xxxxx-x_5a775fdcb14f4431b6c0015618140bc3_go_19/up/up/9Hn1036zgQqL4G805Ufb43H4s1t984",
    "downloadUri" : "https://cloudartifacts-backend.xx-xxxxx-x.myhuaweicloud.com/artgalaxy/xx-xxxxx-x_5a775fdcb14f4431b6c0015618140bc3_go_19/up/up/9Hn1036zgQqL4G805Ufb43H4s1t984",
    "mimeType" : null,
    "size" : "1056",
    "attention" : "0",
    "checksums" : {
      "sha512" : "86b14ee38fbeee9b33184b018dd7740c75acb994292a2f71db7af9952ecb7676fe759cfc3207ab4d5b7f76252c0e3a6683c00e7c0af3cb73282ee05a5441e72c",
      "sha256" : "806f31bcccdf84d133de1b307834e7f4f07810b4f5204bd449ce088c051513a4",
      "sha1" : "20691eee689efdf42e926b52b6f84c51439ab054",
      "md5" : "af5b0888060bcdabc8a5440251556461"
    },
    "packageName" : null,
    "version" : null,
    "groupId" : null,
    "artifactId" : null,
    "properties" : null,
    "downloadInfo" : {
      "uri" : "https://cloudartifacts-backend.xx-xxxxx-x.myhuaweicloud.com/artgalaxy/api/storage/xx-xxxxx-x_5a775fdcb14f4431b6c0015618140bc3_go_19/up/up/9Hn1036zgQqL4G805Ufb43H4s1t984",
      "downloadCount" : 0,
      "lastDownloaded" : 0,
      "remoteDownloadCount" : 0,
      "remoteLastDownloaded" : 0,
      "lastDownloadedBy" : ""
    },
    "gavDisplay" : {
      "gavInfo" : null,
      "configInfo" : ""
    },
    "originalChecksums" : { },
    "displayName" : "go3",
    "display_size" : "1.03 KB"
  }
}

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

    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();
        ListArtifactoryComponentRequest request = new ListArtifactoryComponentRequest();
        request.withTenantId("{tenant_id}");
        request.withProjectId("{project_id}");
        request.withRepoName("{repo_name}");
        try {
            ListArtifactoryComponentResponse response = client.listArtifactoryComponent(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 = ListArtifactoryComponentRequest()
        request.tenant_id = "{tenant_id}"
        request.project_id = "{project_id}"
        request.repo_name = "{repo_name}"
        response = client.list_artifactory_component(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.ListArtifactoryComponentRequest{}
	request.TenantId = "{tenant_id}"
	request.ProjectId = "{project_id}"
	request.RepoName = "{repo_name}"
	response, err := client.ListArtifactoryComponent(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.