文档首页/ 制品仓库 CodeArts Artifact/ API参考/ API/ 私有库文件管理/ 查询仓库文件夹目录 - ShowFileTree
更新时间:2026-07-13 GMT+08:00
分享

查询仓库文件夹目录 - ShowFileTree

功能介绍

根据仓库ID查询指定仓库文件夹下的文件及文件夹列表,包含子文件或文件夹的地址及文件大小等信息。支持查询指定仓库的指定目录。

调用方法

请参见如何调用API

授权信息

账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

codeartsartifact:repository:read

Read

-

-

-

-

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

tenant_id

String

参数解释

租户id,获取方式请参考获取账号ID

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

project_id

String

参数解释

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

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

repo_name

String

参数解释:

仓库id,格式为{region}_{domainId}_{format}_{sequence}。使用查询仓库详情,不会去统计仓库下的制品数量接口的响应体中"name"参数的值作为此参数的值。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

path

String

参数解释

待查询的目录路径,目格式为目录格式,类似于:/path01/path02。

约束限制

不涉及。

取值范围

必传,最大长度1280。

默认取值

不涉及。

instance_id

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

is_recycle_bin

Boolean

参数解释

是否查询回收站文件。

约束限制

不涉及。

取值范围

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

  • false: 查询仓库目录列表。

默认取值

不涉及。

page_no

Integer

参数解释

分页参数,分页的页号。

约束限制

(page_no - 1) * page_size < 2147483647。

取值范围

1-2147483647。

默认取值

不涉及。

page_size

Integer

参数解释

分页参数,分页每页的数据量。

约束限制

(page_no - 1) * page_size < 2147483647。

取值范围

1-100。

默认取值

不涉及。

name

String

参数解释

搜索名称参数,设置后将只返回当前path下左匹配此名称的文件/文件夹。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

x-auth-token

String

参数解释:

用户token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值),调用详情请参考章节。

约束限制:

不涉及。

取值范围:

字符串长度为1-100000。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

status

String

参数解释:

请求成功或失败状态。

取值范围:

  • success:请求成功。

  • error:请求失败。

trace_id

String

参数解释:

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

取值范围:

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

result

ShowFileTreeResult object

参数解释:

仓库目录信息。

取值范围:

不涉及。

表5 ShowFileTreeResult

参数

参数类型

描述

uploadAccess

String

参数解释:

上传权限。

取值范围:

true:有权限。

false:无权限。

total

String

参数解释:

总数。

取值范围:

不涉及。

uri

String

参数解释:

父路径。

取值范围:

不涉及。

created

String

参数解释:

创建时间。

取值范围:

不涉及。

children

Array of children objects

参数解释:

子文件及文件夹信息。

取值范围:

不涉及。

表6 children

参数

参数类型

描述

name

String

参数解释:

文件或文件夹名称。

取值范围:

不涉及。

uri

String

参数解释:

访问地址。

取值范围:

不涉及。

path

String

参数解释:

路径。

取值范围:

不涉及。

modified

String

参数解释:

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

取值范围:

不涉及。

created

String

参数解释:

创建时间。

取值范围:

不涉及。

folder

Boolean

参数解释:

是否为文件夹。

取值范围:

true:文件夹。

false:文件。

modified_by

String

参数解释:

修改人。

取值范围:

不涉及。

modified_by_nick_name

String

参数解释:

修改昵称。

取值范围:

不涉及。

modified_by_tenant_name

String

参数解释:

修改人租户名。

取值范围:

不涉及。

created_by

String

参数解释:

创建人。

取值范围:

不涉及。

download_uri

String

参数解释:

下载链接。

取值范围:

不涉及。

checksum

checksum object

参数解释:

校验合。

has_child

Boolean

参数解释:

是否存在下一层。

取值范围:

true:是。

false:否。

disable

Boolean

参数解释:

制品是否禁用。

取值范围:

true:是。

false:否。

表7 checksum

参数

参数类型

描述

sha512

String

参数解释:

sha512校验和。

取值范围:

不涉及。

sha256

String

参数解释:

sha256校验和。

取值范围:

不涉及。

sha1

String

参数解释:

sha1校验和。

取值范围:

不涉及。

md5

String

参数解释:

md5校验和。

取值范围:

不涉及。

请求示例

查询仓库文件夹目录

https://artifact.example-1.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.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",
      "created" : "2023-11-29 09:56:51",
      "folder" : true,
      "display_size" : null,
      "modified_by" : "devcloud_devcloud_y00226182_01",
      "modified_by_nick_name" : "devcloud_devcloud_y00226182_01",
      "modified_by_tenant_name" : "devcloud_devcloud_y00226182_01",
      "disable" : false,
      "has_child" : "true",
      "download_uri" : "https://cloudartifacts-backend.xx-xxxxx-x.com/artgalaxy/api/storage/auto-trashcan/xx-xxxxx-x_5a775fdcb14f4431b6c0015618140bc3_maven_1_108/1",
      "checksum" : {
        "sha512" : "86b14ee38fbeee9b33184b018dd7740c75acb994292a2f71db7af9952ecb7676fe759cfc3207ab4d5b7f76252c0e3a6683c00e7c0af3cb73282ee05a5441e72c",
        "sha256" : "806f31bcccdf84d133de1b307834e7f4f07810b4f5204bd449ce088c051513a4",
        "sha1" : "20691eee689efdf42e926b52b6f84c51439ab054",
        "md5" : "af5b0888060bcdabc8a5440251556461"
      }
    } ],
    "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
39
40
41
42
43
44
45
46
47
48
49
50
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, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := codeartsartifact.CodeArtsArtifactClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := codeartsartifact.NewCodeArtsArtifactClient(hcClient)

    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

错误码

请参见错误码

相关文档