Help Center/ Workspace/ API Reference/ Workspace Application Streaming APIs/ Storage management/ Querying Shared Storage Directories
Updated on 2026-05-21 GMT+08:00
View PDF
Share

Querying Shared Storage Directories

Function

Queries shared storage directories.

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:storage:listShareFolder

    List

    storage *

    -

    -

    -

URI

GET /v1/{project_id}/persistent-storages/actions/list-share-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.

storage_claim_id

No

String

WKS storage directory declaration ID.

path

No

String

The query name must meet the following requirements:

  1. The value contains visible characters and spaces.

  2. The value contains 0 to 128 characters.

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 SharePersistentStorageClaim objects

Storage statement.
Table 5 SharePersistentStorageClaim

Parameter

Type

Description

storage_claim_id

String

WKS storage directory declaration ID.

folder_path

String

Storage object path.

Note: path indicates the complete path of an object in the system.

For example, the following directory structure exists in the system:

SFS-Tmp:

└─shares

├─image

└─video

Image path: shares/image/

Video path: shares/video/

delimiter

String

Path separator.

claim_mode

String

Type of the storage declaration.

USER: user directory

SHARE: shared directory

count

Map<String,Integer>

Number of users and user groups associated with the shared directory.

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/actions/list-share-folders?limit=10&offset=0

Example Responses

Status code: 200

Response to a successful request.

{
  "count" : 1,
  "items" : [ {
    "storage_claim_id" : "a0890780-7ef2-4aaf-b56d-b25fb53b717e",
    "folder_path" : "shares/video/",
    "delimiter" : "/",
    "claim_mode" : "SHARE",
    "count" : {
      "USER" : 0,
      "USER_GROUP" : 1
    }
  } ]
}

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: Storage management