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

Creating a Personal Folder

Function

If the directory of the personal folder to create already exists, only the policy is updated and the directory is not created repeatedly.

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

    Write

    -

    -

    -
    • sfs3:fileSystem:createFileSystem
    • sfs3:fileSystem:putACL
    • sfs3:fileSystem:putCORS
    • sfs3:fileSystem:putQuota
    • sfs3:file:put

URI

POST /v1/{project_id}/cloud-storages/{storage_id}/actions/create-folder

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

items

Yes

Array of CreateUserAssignmentInfo objects

Storage allocation target.
Table 4 CreateUserAssignmentInfo

Parameter

Mandatory

Type

Description

attach_id

Yes

String

Target user ID.

attach_name

Yes

String

Target user.

file_system_quota

No

Long

Quota.

action_put

No

Boolean

Permission of cloud storage on local devices for upload:

true: allowed

false: not allowed

action_get

No

Boolean

Permission of cloud storage on local devices for download:

true: allowed

false: not allowed

roam_action_put

No

Boolean

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

true: allowed

false: not allowed

roam_action_get

No

Boolean

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

true: allowed

false: not allowed

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

items

Array of CloudStorageAssignmentCreateInfo objects

Response to the request for creating a folder.
Table 6 CloudStorageAssignmentCreateInfo

Parameter

Type

Description

id

String

Unique identifier of the storage.

region_id

String

Region ID.

tenant_id

String

Tenant ID.

domain_id

String

Domain ID.

folder_name

String

Folder name.

attach

String

Username.

attach_id

String

User ID.

attach_type

String

User type.

error_message

String

Error message.

is_success

Boolean

Whether the creation is successful.

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

{
  "items" : [ {
    "attach_id" : "e8be1ecbae8b49ac9ad30124dbe9d41e",
    "attach_name" : "psc",
    "file_system_quota" : 1073741824,
    "action_put" : false,
    "action_get" : false,
    "roam_action_put" : false,
    "roam_action_get" : false
  } ]
}

Example Responses

Status code: 200

Response to a successful request.

{
  "items" : [ {
    "id" : "842486659197960192",
    "region_id" : "cn-north-7",
    "tenant_id" : "5be809d45f1a4bb39c6c9256efe00adf",
    "domain_id" : "06efbb8c1100d47c0f20c00d54efeba0",
    "folder_name" : "My Files1",
    "attach" : "psc",
    "attach_id" : "e8be1ecbae8b49ac9ad30124dbe9d41e",
    "attach_type" : "USER",
    "is_success" : true
  } ]
}

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