Help Center/ Workspace/ API Reference/ Workspace Application Streaming APIs/ CloudStorage/ Querying Folders and Files
Updated on 2026-05-21 GMT+08:00
View PDF
Share

Querying Folders and Files

Function

Queries folders and files in a specified directory.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v1/{project_id}/cloud-storages/actions/list-folder-files

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

user_name

Yes

String

Username.

cloud_storage_assignment_id

No

String

ID of a personal folder. (If a user has multiple folders and the personal folder ID is not specified, the file system that is created earliest is selected for file query.)

folder_url

Yes

String

Folder path to be queried.

marker

No

String

Identifier from which the file list is returned in alphabetical order by file name.

limit

No

Integer

Maximum number of file systems to be listed. The returned file system list is sorted in alphabetical order. The default value is 1000.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

location

String

Code of the region where the file system is located.

prefix

String

Prefix of the absolute path of the file name.

files

Array of FileInfo objects

File list.

folders

Array of FolderInfo objects

Folder list.

marker

String

Start position of the files in the current listing. This parameter is left blank by default.

next_marker

String

Start position of the next listing request. This parameter is left blank by default.

max_keys

Integer

Maximum number of files that can be returned in the current listing. In other listing responses, the smaller one of the input value and the default value is used.
Table 5 FileInfo

Parameter

Type

Description

file_name

String

File name.

size

Long

File size.

content_type

String

MIME type of a file.
Table 6 FolderInfo

Parameter

Type

Description

prefix

String

Folder name.

inode_no

Long

File inode.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 404

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 405

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 500

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 503

Table 13 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Example Requests

GET /v1/a4da8115c9d8464ead3a38309130523f/cloud-storages/actions/list-folder-files

Example Responses

None

Status Codes

Status Code

Description

200

Success.

400

The request cannot be understood by the server due to malformed syntax.

401

Authentication failed.

403

No permissions.

404

Resources not found.

405

The method specified in the request is not allowed.

500

An internal service error occurred. For details, see the error code description.

503

Service unavailable.

Error Codes

See Error Codes.

Parent topic: CloudStorage