更新时间:2025-07-30 GMT+08:00
分享

查询仓库文件详情

功能介绍

查询仓库文件详情

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

tenant_id

String

参数解释

租户id。

约束限制

只能由英文字母、数字组成,且长度为8到32个字符。

取值范围

不涉及。

默认取值

无。

project_id

String

参数解释:

项目ID,可以从调用API处获取,也可以从控制台获取。获取方式请参考获取项目ID

约束限制:

只能由英文字母、数字组成,且长度为32个字符。

取值范围:

不涉及。

默认取值:

无。

repo_name

String

参数解释:

仓库id,格式为{region}{domainId}{format}_{sequence}。可以从私有依赖库首页->仓库概览->仓库地址 url 中获取,最后两个"/"中间的字符串即为仓库id。

约束限制:

不涉及。

取值范围:

根据仓库id格式中region, domainId需要为有效值,format有效值为:npm|go|pypi|rpm|composer|maven|debian|conan|nuget|docker2|cocoapods|ohpm, sequence取值根据套餐不同有不同上限值。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

path

String

参数解释

待查询的文件路径。

约束限制

必传,最大长度1280。

取值范围

不涉及。

默认取值

不涉及。

format

String

参数解释

制品类型。

约束限制

必传。

取值范围

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

默认取值

不涉及。

instance_id

String

参数解释:

实例id。当前该参数已废弃。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

status

String

参数解释:

请求成功、失败状态。

取值范围:

success:请求成功。

error:请求失败。

trace_id

String

参数解释:

请求id,当前请求唯一标识。

取值范围:

数字及中划线(-)组成的字符串。

result

result object

参数解释:

文件详情。

取值范围:

不涉及。

表4 result

参数

参数类型

描述

repo

String

参数解释:

仓库id。

取值范围:

不涉及。

path

String

参数解释:

文件路径。

取值范围:

不涉及。

name

String

参数解释:

文件名。

取值范围:

不涉及。

created

String

参数解释:

创建时间,时间格式:yyyy-MM-dd HH:mm:ss。

取值范围:

不涉及。

createdBy

String

参数解释:

创建人。

取值范围:

不涉及。

lastModified

String

参数解释:

最后修改时间,时间格式:yyyy-MM-dd HH:mm:ss。

取值范围:

不涉及。

lastUpdated

String

参数解释:

最后修改时间,时间格式:yyyy-MM-dd HH:mm:ss。

取值范围:

不涉及。

modifiedBy

String

参数解释:

修改人。

取值范围:

不涉及。

uri

String

参数解释:

访问地址。

取值范围:

不涉及。

downloadUri

String

参数解释:

下载地址。

取值范围:

不涉及。

size

String

参数解释:

文件大小。

取值范围:

不涉及。

attention

String

参数解释:

是否关注。

取值范围:

1,表示已关注。

0,表示未关注。

checksums

checksums object

参数解释:

校验和。

取值范围:

不涉及。

downloadInfo

downloadInfo object

参数解释:

下载信息。

取值范围:

不涉及。

gavDisplay

gavDisplay object

参数解释:

坐标信息。

取值范围:

不涉及。

originalChecksums

Object

参数解释:

校验和。

取值范围:

不涉及。

displayName

String

参数解释:

展示的名称。

取值范围:

不涉及。

display_size

String

参数解释:

展示的大小。

取值范围:

不涉及。

表5 checksums

参数

参数类型

描述

sha512

String

参数解释:

sha512校验和。

取值范围:

不涉及。

sha256

String

参数解释:

sha256校验和。

取值范围:

不涉及。

sha1

String

参数解释:

sha1校验和。

取值范围:

不涉及。

md5

String

参数解释:

md5校验和。

取值范围:

不涉及。

表6 downloadInfo

参数

参数类型

描述

uri

String

参数解释:

文件地址。

取值范围:

不涉及。

downloadCount

Long

参数解释:

下载次数。

取值范围:

不涉及。

lastDownloaded

Long

参数解释:

最后一次下载时间。

取值范围:

不涉及。

remoteDownloadCount

Long

参数解释:

被远程下载次数。

取值范围:

不涉及。

remoteLastDownloaded

Long

参数解释:

被远程下载时间。

取值范围:

不涉及。

lastDownloadedBy

String

参数解释:

最后下载人。

取值范围:

不涉及。

表7 gavDisplay

参数

参数类型

描述

gavInfo

String

参数解释:

坐标信息。

取值范围:

不涉及。

configInfo

String

参数解释:

配置信息。

取值范围:

不涉及。

请求示例

查询仓库文件详情

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

响应示例

状态码: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代码示例

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
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)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档