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

Querying Personal Folders

Function

Queries personal folders.

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, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    workspace:cloudStorage:listFolder

    List

    -

    -

    -
    • sfs3:fileSystem:getFileSystem
    • sfs3:fileSystem:listFiles

URI

GET /v1/{project_id}/cloud-storages/actions/list-folders

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Query offset.

limit

No

Integer

Size of a single query. The value ranges from 1 to 100.

storage_id

Yes

String

WKS storage ID.

claim_mode

Yes

String

Storage declaration type. Currently, only USER is supported.

  • USER: Personal folder

  • SHARE: Shared folder

attach

No

String

Name of an assigned user or user group. This parameter does not take effect when attach_names is transferred.

attach_names

No

Array of strings

Name of an assigned user or user group.

capacity_filter

No

String

Whether to query capacity:

  • true: yes

  • false: no

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

count

Integer

Total number.

items

Array of CloudStorageAssignment objects

Queries the user storage statement configuration.
Table 5 CloudStorageAssignment

Parameter

Type

Description

cloud_storage_assignment_id

String

ID.

attach_name

String

Username.

used_quota

Long

Used capacity (unit: B).

quota

Long

Total capacity (unit: B).

create_time

String

Creation time.

action_put

Boolean

Permission of cloud storage on local devices for upload:

true: allowed

false: not allowed

action_get

Boolean

Permission of cloud storage on local devices for download:

true: allowed

false: not allowed

roam_action_put

Boolean

Permission of cloud storage on cloud desktops/cloud applications for upload:

true: allowed

false: not allowed

roam_action_get

Boolean

Permission of cloud storage on cloud desktops/cloud applications for download:

true: allowed

false: not allowed

Status code: 400

Table 6 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 7 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 8 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 9 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 10 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 11 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 12 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-attachments?storage_id=544959151881584640&claim_mode=SHARE&limit=10&offset=0

Example Responses

Status code: 200

Response to a successful request.

{
  "count" : 0,
  "items" : [ { } ]
}

Status Codes

Status Code

Description

200

Response to a successful request.

400

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

401

Authentication failed.

403

Permissions required.

404

No resources found.

405

The request method 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