Help Center/ Scalable File Service/ API Reference/ SFS Turbo APIs/ Lifecycle Management/ Creating a File System

Updated on 2024-11-13 GMT+08:00

View PDF

Creating a File System

Function

This API is used to create a file system.

URI

POST /v1/{project_id}/sfs-turbo/shares

**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	Yes	String	Account token
Content-Type	Yes	String	MIME type

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
share	Yes	Share object	Request body for creating a file system
bss_param	No	BssInfo object	Yearly/Monthly billing mode. This parameter is mandatory.

**Table 4** Share
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.
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.
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. Valid values are STANDARD and PERFORMANCE. This field is not returned when the file system is being created. For a previous-generation SFS Turbo file system, specify STANDARD for a Standard or Standard-Enhanced file system, and PERFORMANCE for a Performance or Performance-Enhanced file system. For a 1,000 MB/s/TiB, 500 MB/s/TiB, 250 MB/s/TiB, 125 MB/s/TiB, 40 MB/s/TiB, or 20 MB/s/TiB file system, this field is not verified. Specify either STANDARD or PERFORMANCE.
size	Yes	Integer	For a previous-generation SFS Turbo file system, the capacity ranges from 500 to 32768, in GiB. For a previous-generation SFS Turbo file system with expand_type="bandwidth" configured under metadata, the capacity ranges from 10240 to 3276800, in GiB. For a 20 MB/s/TiB file system with expand_type="hpc" and hpc_bw="20M" configured under metadata, the capacity ranges from 3686 to 1048576 (in GiB) and must be a multiple of 1.2 TiB. The desired capacity must be converted to GiB and rounded down to the nearest integer. For example, specify 3686 GiB for a 3.6 TiB file system, 4915 GiB for a 4.8 TiB file system, and 8601 GiB for a 8.4 TiB file system. For a 40 MB/s/TiB file system with expand_type="hpc" and hpc_bw="40M" configured under metadata, the capacity ranges from 1228 to 1048576 (in GiB) and must be a multiple of 1.2 TiB. The desired capacity must be converted to GiB and rounded down to the nearest integer. For example, specify 3686 GiB for a 3.6 TiB file system, 4915 GiB for a 4.8 TiB file system, and 8601 GiB for a 8.4 TiB file system. For a 125 MB/s/TiB file system with expand_type="hpc" and hpc_bw="125M" configured under metadata, the capacity ranges from 1228 to 1048576 (in GiB) and must be a multiple of 1.2 TiB. The desired capacity must be converted to GiB and rounded down to the nearest integer. For example, specify 3686 GiB for a 3.6 TiB file system, 4915 GiB for a 4.8 TiB file system, and 8601 GiB for a 8.4 TiB file system. For a 250 MB/s/TiB file system with expand_type="hpc" and hpc_bw="250M" configured under metadata, the capacity ranges from 1228 to 1048576 (in GiB) and must be a multiple of 1.2 TiB. The desired capacity must be converted to GiB and rounded down to the nearest integer. For example, specify 3686 GiB for a 3.6 TiB file system, 4915 GiB for a 4.8 TiB file system, and 8601 GiB for a 8.4 TiB file system. - For a 500 MB/s/TiB file system with expand_type="hpc" and hpc_bw="500M" configured under metadata, the capacity ranges from 1228 to 1048576 (in GiB) and must be a multiple of 1.2 TiB. The desired capacity must be converted to GiB and rounded down to the nearest integer. For example, specify 3686 GiB for a 3.6 TiB file system, 4915 GiB for a 4.8 TiB file system, and 8601 GiB for a 8.4 TiB file system. - For a 1,000 MB/s/TiB file system with expand_type="hpc" and hpc_bw="1000M" configured under metadata, the capacity ranges from 1228 to 1048576 (in GiB) and must be a multiple of 1.2 TiB. The desired capacity must be converted to GiB and rounded down to the nearest integer. For example, specify 3686 GiB for a 3.6 TiB file system, 4915 GiB for a 4.8 TiB file system, and 8601 GiB for a 8.4 TiB file system.
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.
tags	No	Array of ResourceTag objects	Tag list

**Table 5** Metadata
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. This parameter is not returned when the file system is being created. This parameter is mandatory when you are creating an SFS Turbo 1,000 MB/s/TiB, 500 MB/s/TiB, 250 MB/s/TiB, 125 MB/s/TiB, 40 MB/s/TiB, 20 MB/s/TiB, or Enhanced file system. Specify bandwidth when you are creating a Standard-Enhanced or Performance-Enhanced file system. Specify hpc when you are creating a 1,000 MB/s/TiB, 500 MB/s/TiB, 250 MB/s/TiB, 125 MB/s/TiB, 40 MB/s/TiB, or 20 MB/s/TiB file system.
hpc_bw	No	String	File system bandwidth. This parameter is mandatory when you are creating an SFS Turbo 1,000 MB/s/TiB, 500 MB/s/TiB, 250 MB/s/TiB, 125 MB/s/TiB, 40 MB/s/TiB, or 20 MB/s/TiB file system. Specify 20M for a 20 MB/s/TiB file system, 40M for a 40 MB/s/TiB file system, 125M for a 125 MB/s/TiB file system, and 250M for a 250 MB/s/TiB file system. Specify 500M for a 500 MB/s/TiB file system and 1000M for a 1,000 MB/s/TiB file system.

**Table 6** ResourceTag
Parameter	Mandatory	Type	Description
key	Yes	String	Tag key. It can contain a maximum of 128 characters. It cannot be left empty and cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (), commas (,), vertical bars (\|), and slashes (/). It can contain only letters, digits, hyphens (-), and underscores (_).
value	Yes	String	Tag value. Each tag value can contain a maximum of 255 characters and can be an empty string. It cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (), commas (,), vertical bars (\|), and slashes (/). It can contain only letters, digits, hyphens (-), and underscores (_).

**Table 7** BssInfo
Parameter	Mandatory	Type	Description
is_auto_renew	No	Long	Whether to enable automatic renewal
period_num	Yes	Long	Yearly/Monthly subscription terms
period_type	Yes	Long	Yearly/Monthly subscription type. The value can be 2 (monthly subscription) or 3 (yearly subscription).
is_auto_pay	No	Long	Whether to automatically pay for the order

Response Parameters

Status code: 202

**Table 8** Response body parameters
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

Previous-generation SFS Turbo file system:

This example creates an SFS Turbo Standard file system in the AZ whose AZ code is example, with the file system name set to sfs-turbo-test, protocol type to NFS, capacity to 500 GB. The security group ID is 8c4ebbd0-6edf-4aae-8353-xxx, the subnet ID is b8884abe-f47b-4917-9f6c-xxx, and the VPC ID is d651ea2b-2b20-4c6d-8bbf-xxx.

POST HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares

{
  "share" : {
    "name" : "sfs-turbo-test",
    "availability_zone" : "example",
    "security_group_id" : "8c4ebbd0-6edf-4aae-8353-xxx",
    "share_proto" : "NFS",
    "share_type" : "STANDARD",
    "size" : 500,
    "subnet_id" : "b8884abe-f47b-4917-9f6c-xxx",
    "vpc_id" : "d651ea2b-2b20-4c6d-8bbf-xxx"
  }
}

Previous-generation SFS Turbo file system in a dedicated scenario:

This example creates an SFS Turbo Standard file system in the AZ whose AZ code is example, with the file system name set to sfs-turbo-dedicated-test, protocol type to NFS, capacity to 500 GB. The dedicated storage pool ID is 198f0704-xxx-4d85-xxx-c25caa4d3264, the dedicated ECS flavor is c6.xlarge.2, the security group ID is 8c4ebbd0-6edf-4aae-8353-xxx, the subnet ID is b8884abe-f47b-4917-9f6c-xxx, and the VPC ID is d651ea2b-2b20-4c6d-8bbf-xxx.

POST HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares

{
  "share" : {
    "name" : "sfs-turbo-dedicated-test",
    "availability_zone" : "example",
    "security_group_id" : "8c4ebbd0-6edf-4aae-8353-xxx",
    "share_proto" : "NFS",
    "share_type" : "STANDARD",
    "size" : 500,
    "subnet_id" : "b8884abe-f47b-4917-9f6c-xxx",
    "vpc_id" : "d651ea2b-2b20-4c6d-8bbf-xxx",
    "metadata" : {
      "dedicated_flavor" : "c6.xlarge.2",
      "dedicated_storage_id" : "198f0704-xxx-4d85-xxx-c25caa4d3264"
    }
  }
}

125 MB/s/TiB:

This example creates an SFS Turbo 125 MB/s/TiB file system in the AZ whose AZ code is example, with the file system name set to sfs-turbo-test, protocol type to NFS, capacity to 3686 GB. The security group ID is 8c4ebbd0-6edf-4aae-8353-xxx, the subnet ID is b8884abe-f47b-4917-9f6c-xxx, and the VPC ID is d651ea2b-2b20-4c6d-8bbf-xxx.

POST HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares

{
  "share" : {
    "name" : "sfs-turbo-test",
    "availability_zone" : "example",
    "security_group_id" : "8c4ebbd0-6edf-4aae-8353-xxx",
    "share_proto" : "NFS",
    "share_type" : "STANDARD",
    "size" : 3686,
    "subnet_id" : "b8884abe-f47b-4917-9f6c-xxx",
    "vpc_id" : "d651ea2b-2b20-4c6d-8bbf-xxx",
    "metadata" : {
      "expand_type" : "hpc",
      "hpc_bw" : "125M"
    }
  }
}

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.

Parent topic: Lifecycle Management

Previous topic: Lifecycle Management

Next topic: Querying Details About a File System

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot