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

Querying the Repository Folder Directory

Function

Query the repository folder directory.

Calling Method

For details, see Calling APIs.

URI

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

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:

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.

Value range:

N/A

Default value:

None

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

path

Yes

String

Definition:

Path of the directory to be queried.

Constraints:

Mandatory. The maximum length is 1,280 characters.

Value range:

N/A

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

is_recycle_bin

No

Boolean

Definition:

Whether to query files in the recycle bin.

Constraints:

N/A

Value range:

true: query the recycle bin list of a repository.

false: query the directory list of a repository.

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

ShowFileTreeResult object

Definition:

Repository directory information.

Value range:

N/A

Table 4 ShowFileTreeResult

Parameter

Type

Description

uploadAccess

String

Definition:

Upload permission.

Value range:

true: with permission.

false: without permission.

total

String

Definition:

Total number.

Value range:

N/A

uri

String

Definition:

Parent path.

Value range:

N/A

created

String

Definition:

Creation time.

Value range:

N/A

children

Array of children objects

Definition:

Information about a subfile or subfolder.

Value range:

N/A

Table 5 children

Parameter

Type

Description

name

String

Definition:

Name of a file or folder.

Value range:

N/A

uri

String

Definition:

Access address.

Value range:

N/A

path

String

Definition:

Path.

Value range:

N/A

modified

String

Definition:

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

Value range:

N/A

folder

Boolean

Definition:

Folder or not.

Value range:

true: folder.

false: file.

modified_by

String

Definition:

Modifier.

Value range:

N/A

has_child

Boolean

Definition:

Whether a lower layer exists.

Value range:

true: yes

false: no

Example Requests

Query the repository folder directory.

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

Example Responses

Status code: 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 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 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)
    }
}

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.