Function
Creates a shared storage directory.
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:createShareFolder | Write | storage * | - | - | - obs:object:getObject
- obs:object:putObject
|
URI
POST /v1/{project_id}/persistent-storages/{storage_id}/actions/create-share-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 3 Request body parameters | Parameter | Mandatory | Type | Description |
| folder_name | No | String | -
Only single-level folders can be created. -
A folder name can contain only letters, digits, spaces, underscores (_), and hyphens (-). -
The name cannot exceed 32 characters. -
The value cannot contain only spaces or start with a space. |
Response Parameters
Status code: 200
Table 4 Response body parameters | 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 |
Status code: 400
Table 5 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 6 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 7 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 8 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 9 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 10 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 11 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/566337783841423360/actions/create-share-folder
{
"folder_name" : "tmp"
} Example Responses
Status code: 200
Response to a successful request.
{
"storage_claim_id" : 569314983280640000,
"folder_path" : "shares/video/",
"delimiter" : "/",
"claim_mode" : "SHARE"
} 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. |
