Creating a File System

Function

This API is used to create a file system.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	The project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	The account token.
Content-Type	Yes	String	The MIME type.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
share	Yes	Share object	The parameters for creating a file system.
bss_param	No	BssInfo object	This parameter is mandatory when the yearly/monthly billing mode is used.

**Table 4** Share
Parameter	Mandatory	Type	Description
availability_zone	Yes	String	The code of the AZ where the file system resides.
description	No	String	The file system description. It can contain 0 to 255 characters.
enterprise_project_id	No	String	The ID of the enterprise project that the file system will be added to.
metadata	No	Metadata object	The file system metadata. The value consists of one or multiple key-value pairs organized as a directory of strings.
name	Yes	String	The file system name. The name can contain 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	The security group ID of a tenant in a region.
share_proto	Yes	String	Network File System (NFS) is a distributed file system protocol that allows different computers and OSs to share data over a network. You are advised to use NFS file systems with Linux servers. Common Internet File System (CIFS) is a protocol used for network file sharing. CIFS is a dialect of the SMB protocol, meaning that it is a specific implementation or variation of the SMB protocol. CIFS is also a public or open version of the SMB protocol. It allows applications to access files on computers over the Internet and request for file services. Using CIFS, network files can be shared between Windows hosts. CIFS file systems cannot be mounted to Linux servers. You are advised to use CIFS file systems with Windows servers.
share_type	Yes	String	The 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 set to bandwidth in metadata, the capacity ranges from 10240 to 327680, in GiB. For a 20 MB/s/TiB file system with expand_type set to hpc and hpc_bw set to 20M in 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 an 8.4 TiB file system. For a 40 MB/s/TiB file system with expand_type set to hpc and hpc_bw set to 40M in 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 an 8.4 TiB file system. For a 125 MB/s/TiB file system with expand_type set to hpc and hpc_bw set to 125M in 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 an 8.4 TiB file system. For a 250 MB/s/TiB file system with expand_type set to hpc and hpc_bw set to 250M in 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 an 8.4 TiB file system. For a 500 MB/s/TiB file system with expand_type set to hpc and hpc_bw set to 500M in 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 an 8.4 TiB file system. For a 1,000 MB/s/TiB file system with expand_type set to hpc and hpc_bw set to 1000M in 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 an 8.4 TiB file system.
subnet_id	Yes	String	The subnet ID of a tenant in a VPC.
vpc_id	Yes	String	The VPC ID of a tenant in a region.
backup_id	No	String	The backup ID. This parameter is mandatory if you create a file system from a backup.
tags	No	Array of ResourceTag objects	The tag list.

**Table 5** Metadata
Parameter	Mandatory	Type	Description
crypt_key_id	No	String	The ID of a KMS professional key, which is used to create an encrypted file system.
dedicated_flavor	No	String	The VM flavor, which is used to create a dedicated file system.
dedicated_storage_id	No	String	The ID of the dedicated distributed storage, which is used to create a dedicated file system.
expand_type	No	String	The extension type. This parameter is not returned when the file system is being created. Enumeration values: bandwidth: Specify bandwidth when you are creating a Standard-Enhanced or Performance-Enhanced file system. hpc: 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	The file system bandwidth. This parameter is mandatory 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. Specify 20M for a 20 MB/s/TiB file system and specify 40M for a 40 MB/s/TiB file system. Specify 125M for a 125 MB/s/TiB file system and specify 250M for a 250 MB/s/TiB file system. Specify 500M for a 500 MB/s/TiB file system and specify 1000M for a 1,000 MB/s/TiB file system.
auto_create_security_group_rules	No	String	Whether to automatically create security group rules. true automatically creates security group rules. false does not automatically create security group rules. The default value is true. Enumeration values: true false
vault_id	No	String	The vault ID.

**Table 6** ResourceTag
Parameter	Mandatory	Type	Description
key	Yes	String	The 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	The 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 auto-renewal. 0 disables auto-renewal. 1 enables auto-renewal. Enumeration values: 0 1
period_num	Yes	Long	The yearly/monthly subscription terms.
period_type	Yes	Long	The yearly/monthly subscription type. The value can be 2 (monthly subscription) or 3 (yearly subscription). Enumeration values: 2 3
is_auto_pay	No	Long	Whether to automatically pay for the order after it is created. 0 disables auto payment. 1 enables auto payment. Enumeration values: 0 1

Response Parameters

Status code: 202

**Table 8** Response body parameters
Parameter	Type	Description
id	String	The ID of the created SFS Turbo file system.
name	String	The name of the created SFS Turbo file system.
status	String	The SFS Turbo file system status. Enumeration values: 100: creating

Example Requests

SFS Turbo previous-generation file system types: 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"
  }
}

SFS Turbo previous-generation file system types in dedicated scenarios: 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 a 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, and 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

Successful file system creation

{
  "id" : "708c017c-54b5-429a-a098-7692e23fa518",
  "name" : "sfs-turbo-test",
  "status" : "100"
}

Status Codes

Status Code	Description
202	Successful file system creation

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.

The system is busy. Please try again later.