Help Center/ Workspace/ API Reference/ Workspace Application Streaming APIs/ CloudStorage/ Switching the Cluster to Which a Folder Belongs
Updated on 2026-05-21 GMT+08:00
View PDF
Share

Switching the Cluster to Which a Folder Belongs

Function

Switches the cluster to which a folder belongs.

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:changeCluster

    Write

    -

    -

    -

    -

URI

POST /v1/{project_id}/cloud-storages/{storage_id}/actions/change-cluster

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

storage_id

Yes

String

WKS storage ID.

Request Parameters

Table 2 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.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

target_cluster_group_id

Yes

String

Target cluster ID.

target_project_config_id

Yes

String

Target project configuration ID.

cloud_storage_assignment_ids

Yes

Array of strings

File system IDs. The number of IDs ranges from 1 to 50.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

items

Array of ChangeCloudStorageAssignmentInfo objects

Response to the request for switching a folder.
Table 5 ChangeCloudStorageAssignmentInfo

Parameter

Type

Description

id

String

Unique identifier of storage.

attach_id

String

Target user ID.

attach

String

Target user.

quota

Long

Quota.

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

POST /v1/a4da8115c9d8464ead3a38309130523f/cloud-storages/838207948076351488/actions/change-cluster

Example Responses

Status code: 200

Success.

null

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