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

Creating Workspace Storage

Function

Creates Workspace storage. Currently, only SFS 3.0 Capacity-Oriented file systems can be created.

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

    Write

    storage *

    -

    -
    • obs:bucket:headBucket
    • obs:bucket:putBucketPolicy
    • obs:bucket:putBucketAcl
    • obs:bucket:putBucketCORS
    • obs:bucket:listBucket

URI

POST /v1/{project_id}/persistent-storages

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project 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

name

Yes

String

WKS storage name, which must meet the following requirements:

  1. The name can contain visible characters or spaces but cannot contain only spaces.

  2. The value contains 1 to 128 characters.

storage_metadata

Yes

Storage object

Storage definition metadata.
Table 4 Storage

Parameter

Mandatory

Type

Description

storage_handle

Yes

String

SFS file system name.

storage_class

Yes

String

Storage type.

sfs: SFS 3.0 storage

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

id

String

WKS storage ID.

name

String

Name.

storage_metadata

StorageMetadata object

Storage definition.

create_time

String

Creation time.

user_claim_count

Integer

Number of personal directory statements.

share_claim_count

Integer

Number of shared directory declarations.
Table 6 StorageMetadata

Parameter

Type

Description

storage_handle

String

SFS file system name.

storage_class

String

Storage type.

sfs: SFS 3.0 storage

name

String

Name.

region

String

Region.

export_location

String

URL: protocol://[bucket-name].sfs3.[region-name].myhuaweicloud.com:port.

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

POST /v1/a4da8115c9d8464ead3a38309130523f/persistent-storages

{
  "name" : "sfs-tmp",
  "storage_metadata" : {
    "storage_handle" : "sfs-tmp",
    "storage_class" : "sfs"
  }
}

Example Responses

Status code: 200

Response to a successful request.

{
  "id" : 560329060530520064,
  "name" : "user-file-persistent",
  "storage_metadata" : {
    "storage_handle" : "sfs-tmp",
    "storage_class" : "sfs",
    "name" : "sfs-tmp",
    "region" : "cn-north-5",
    "export_location" : "https://sfs3.cn*****.huaweicloud.com:443"
  },
  "create_time" : "2023-06-08T06:50:39.704Z",
  "user_claim_count" : 0,
  "share_claim_count" : 0
}

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