更新时间:2025-09-08 GMT+08:00

查询仓库文件夹目录

功能介绍

查询仓库文件夹目录

调用方法

请参见如何调用API

URI

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

表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。

取值范围

不涉及。

默认取值

不涉及。

instance_id

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

is_recycle_bin

Boolean

参数解释

是否查询回收站文件。

约束限制

不涉及。

取值范围

true:查询仓库回收站列表。

false:查询仓库目录列表。

默认取值

不涉及。

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

status

String

参数解释:

请求成功、失败状态。

取值范围:

success:请求成功。

error:请求失败。

trace_id

String

参数解释:

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

取值范围:

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

result

ShowFileTreeResult object

参数解释:

仓库目录信息。

取值范围:

不涉及。

表4 ShowFileTreeResult

参数

参数类型

描述

uploadAccess

String

参数解释:

上传权限。

取值范围:

true:有权限。

false:无权限。

total

String

参数解释:

总数。

取值范围:

不涉及。

uri

String

参数解释:

父路径。

取值范围:

不涉及。

created

String

参数解释:

创建时间。

取值范围:

不涉及。

children

Array of children objects

参数解释:

子文件及文件夹信息。

取值范围:

不涉及。

表5 children

参数

参数类型

描述

name

String

参数解释:

文件或文件夹名称。

取值范围:

不涉及。

uri

String

参数解释:

访问地址。

取值范围:

不涉及。

path

String

参数解释:

路径。

取值范围:

不涉及。

modified

String

参数解释:

更新时间,时间格式:yyyy-MM-dd HH:mm:ss。

取值范围:

不涉及。

folder

Boolean

参数解释:

是否为文件夹。

取值范围:

true:文件夹。

false:文件。

modified_by

String

参数解释:

修改人。

取值范围:

不涉及。

has_child

Boolean

参数解释:

是否存在下一层。

取值范围:

true:是。

false:否。

请求示例

查询仓库文件夹目录

https://artifact.cn-south-1.myhuaweicloud.com/cloudartifact/v5/00000000000000000000000000000000/11111111111111111111111111111111/xx-xxxxx-x_5a775fdcb14f4431b6c0015618140bc3_maven_1_108/file-tree?path=/&is_recycle_bin=true

响应示例

状态码:200

OK

{
  "status" : "success",
  "trace_id" : "143002-1701223028671-441",
  "result" : {
    "children" : [ {
      "name" : "1",
      "uri" : "https://cloudartifacts-backend.xx-xxxxx-x.myhuaweicloud.com/artgalaxy/api/storage/auto-trashcan/xx-xxxxx-x_5a775fdcb14f4431b6c0015618140bc3_maven_1_108/1",
      "path" : "xx-xxxxx-x_5a775fdcb14f4431b6c0015618140bc3_maven_1_108/1",
      "modified" : "2023-11-29 09:56:51",
      "folder" : true,
      "display_size" : null,
      "modified_by" : "devcloud_devcloud_y00226182_01",
      "has_child" : "true"
    } ],
    "uploadAccess" : false,
    "total" : 1,
    "uri" : "/xx-xxxxx-x_5a775fdcb14f4431b6c0015618140bc3_maven_1_108",
    "created" : "2023-11-29T09:56:51.349+08:00"
  }
}

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

    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();
        ShowFileTreeRequest request = new ShowFileTreeRequest();
        request.withTenantId("{tenant_id}");
        request.withProjectId("{project_id}");
        request.withRepoName("{repo_name}");
        try {
            ShowFileTreeResponse response = client.showFileTree(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 = ShowFileTreeRequest()
        request.tenant_id = "{tenant_id}"
        request.project_id = "{project_id}"
        request.repo_name = "{repo_name}"
        response = client.show_file_tree(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.ShowFileTreeRequest{}
	request.TenantId = "{tenant_id}"
	request.ProjectId = "{project_id}"
	request.RepoName = "{repo_name}"
	response, err := client.ShowFileTree(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK

错误码

请参见错误码