Creating a File System
Function
This API is used to create a file system.
URI
POST /v1/{project_id}/sfs-turbo/shares
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
project_id |
Yes |
String |
Project ID |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
X-Auth-Token |
Yes |
String |
Account token |
Content-Type |
Yes |
String |
MIME type |
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
share |
Yes |
Share object |
Request body for creating a file system |
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
availability_zone |
Yes |
String |
Code of the AZ where the file system resides |
description |
No |
String |
Description of the file system, which can contain 0 to 255 characters. This parameter is not supported by the current version. Minimum: 0 Maximum: 255 |
enterprise_project_id |
No |
String |
ID of the enterprise project to which the file system will be added |
metadata |
No |
Metadata object |
Metadata of the file system. The value consists of key and value pairs as a directory of strings. |
name |
Yes |
String |
Name of the SFS Turbo file system. The name contains 4 to 64 characters and must start with a letter. It can contain letters (case insensitive), digits, hyphens (-), and underscores (_), and cannot contain other special characters. Minimum: 4 Maximum: 64 |
security_group_id |
Yes |
String |
Security group ID of a tenant in a region |
share_proto |
Yes |
String |
File sharing protocol. The valid value is NFS. Network File System (NFS) is a distributed file system protocol that allows different computers and operating systems to share data over a network. |
share_type |
Yes |
String |
File system type. The valid values are STANDARD and PERFORMANCE. |
size |
Yes |
Integer |
File system capacity. For a standard file system, the value ranges from 500 to 32768, in GB. For an enhanced file system, with the expand_type field set under metadata, the value ranges from 10240 to 327680, in GB. Minimum: 500 Maximum: 327680 |
subnet_id |
Yes |
String |
Subnet ID of a tenant in a VPC |
vpc_id |
Yes |
String |
VPC ID of a tenant in a region |
backup_id |
No |
String |
Backup ID. This parameter is mandatory if you create a file system from a backup. |
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
crypt_key_id |
No |
String |
ID of a KMS professional key. This parameter is used if you want to create an encrypted file system. |
dedicated_flavor |
No |
String |
VM flavor used for creating a dedicated file system |
dedicated_storage_id |
No |
String |
ID of the dedicated distributed storage used when creating a dedicated file system |
expand_type |
No |
String |
Extension type. The valid value is bandwidth, indicating an enhanced file system. |
Response Parameters
Status code: 202
Parameter |
Type |
Description |
|---|---|---|
id |
String |
ID of the created SFS Turbo file system |
name |
String |
Name of the created SFS Turbo file system |
status |
String |
Status of the SFS Turbo file system |
Example Requests
{
"share" : {
"availability_zone" : "az1",
"metadata" : {
"crypt_key_id" : "015bf4b8-73cc-4235-8595-46931de7dfd0",
"dedicated_flavor" : "c3.large.4",
"dedicated_storage_id" : "198f0704-63fc-4d85-b15d-c25caa4d3264"
},
"name" : "sfs-turbo-test",
"security_group_id" : "8c4ebbd0-6edf-4aae-8353-81ce6d06e1f4",
"share_proto" : "NFS",
"share_type" : "STANDARD",
"size" : 500,
"subnet_id" : "b8884abe-f47b-4917-9f6c-f64825c365db",
"vpc_id" : "d651ea2b-2b20-4c6d-8bbf-2adcec18dac9"
}
}
Example Responses
Status code: 202
Response body for creating a file system
{
"id" : "708c017c-54b5-429a-a098-7692e23fa518",
"name" : "sfs-turbo-test",
"status" : "100"
}
Status Codes
Status Code |
Description |
|---|---|
202 |
Response body for creating a file system |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
