Help Center/ CodeArts Artifact/ API Reference/ API/ File Management/ Querying the Repository Folder Directory

Updated on 2025-12-05 GMT+08:00

View PDF

Querying the Repository Folder Directory

Function

This API is used to 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. Range N/A. Default value None
project_id	Yes	String	Definition Project ID, which 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 contains 32 characters. Only letters and digits are supported. 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. 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. Range N/A. Default value N/A.
instance_id	No	String	Definition Instance ID. This parameter is no longer used. Constraints N/A. Range N/A. Default value N/A.
is_recycle_bin	No	Boolean	Definition Whether to query files in the recycle bin. Constraints N/A. 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. Range success: The request is successful. error: The request fails.
trace_id	String	Definition Request ID, which uniquely identifies the current request. Range A string of digits and hyphens (-).
result	ShowFileTreeResult object	Definition Repository directory information. Range N/A.

**Table 4** ShowFileTreeResult
Parameter	Type	Description
uploadAccess	String	Definition Upload permission. Range true: with permission. false: without permission.
total	String	Definition Total number. Range N/A.
uri	String	Definition Parent path. Range N/A.
created	String	Definition Creation time. Range N/A.
children	Array of children objects	Definition Information about a subfile or subfolder. Range N/A.

**Table 5** children
Parameter	Type	Description
name	String	Definition Name of a file or folder. Range N/A.
uri	String	Definition Access address. Range N/A.
path	String	Definition Path. Range N/A.
modified	String	Definition Update time, in yyyy-MM-dd HH:mm:ss format. Range N/A.
folder	Boolean	Definition Folder or not. Range true: folder. false: file.
modified_by	String	Definition Modifier. Range N/A.
has_child	Boolean	Definition Whether a lower layer exists. Range true: yes false: no

Example Requests

This API is used to query the repository folder directory.

https://artifact.example.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

{
  "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"
  }
}