CreateFileSystem - Cloud Parallel File Storage - Alibaba Cloud Documentation Center

Creates a file system.

Operation description

Before you call this operation, you must understand the billing and pricing of Apsara File Storage NAS. For more information, see Billing and Pricing .
Before you create a file system, you must complete real-name verification. For more information, see Real-name verification.
When you call this operation, a service-linked role of NAS is automatically created. For more information, see Manage the service-linked roles of NAS.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
nas:CreateFileSystem	create	FileSystem `acs:nas:{#regionId}:{#accountId}:filesystem/`	nas:EncryptedType nas:FileSystemType	none

Request parameters

Parameter	Type	Required	Description	Example
FileSystemType	string	No	The type of the file system. Valid values: standard: General-purpose Apsara File Storage NAS (NAS) file system extreme: Extreme NAS file system. cpfs: CPFS file system	standard
ChargeType	string	No	The billing method. Valid values: PayAsYouGo (default): pay-as-you-go Subscription	PayAsYouGo
Duration	integer	No	The subscription duration. This parameter is valid and required only if the ChargeType parameter is set to Subscription. Unit: months. If you do not renew a subscription file system when the file system expires, the file system is automatically released.	1
Capacity	long	No	Specify the capacity of the file system. Unit: GiB. Specify the Capacity parameter when the FileSystemType parameter is set to extreme or cpfs. Specify a value based on the specifications on the following buy page: Extreme NAS file system (Pay-as-you-go) CPFS file system (Pay-as-you-go)	100
Bandwidth	long	No	The maximum throughput of the file system. Unit: MB/s. Specify a value based on the specifications on the buy page. CPFS file system (Pay-as-you-go)	150
StorageType	string	Yes	The storage type. If the FileSystemType parameter is set to standard, set the StorageType parameter to Performance, Capacity, or Premium. If the FileSystemType parameter is set to extreme, set the StorageType parameter to standard or advance. If the FileSystemType parameter is set to cpfs, set the StorageType parameter to advance_100 (100 MB/s/TiB baseline) or advance_200 (200 MB/s/TiB baseline).	Performance
ZoneId	string	No	The ID of the zone. Each region has multiple isolated locations known as zones. Each zone has its own independent power supply and network. This parameter is not required if the FileSystemType parameter is set to standard. By default, a random zone is selected based on the protocol type and storage type. This parameter is required if the FileSystemType parameter is set to extreme or cpfs. Note An Elastic Compute Service (ECS) instance and a NAS file system that reside in different zones of the same region can access each other. We recommend that you select the zone where the ECS instance resides. This prevents cross-zone latency between the file system and the ECS instance.	cn-hangzhou-b
ProtocolType	string	Yes	Specify the protocol type. If the FileSystemType parameter is set to standard, set the ProtocolType parameter to NFS or SMB. If the FileSystemType parameter is set to extreme, set the ProtocolType parameter to NFS. If the FileSystemType parameter is set to cpfs, set the ProtocolType parameter to cpfs.	NFS
EncryptType	integer	No	Specifies whether to encrypt data in the file system. You can use the keys that are managed by Key Management Service (KMS) to encrypt data in a file system. When you read and write the encrypted data, the data is automatically decrypted. Valid values: 0 (default): The data in the file system is not encrypted. 1: A NAS-managed key is used to encrypt the data in the file system. This value is valid only if the FileSystemType parameter is set to standard or extreme. 2: A KMS-managed key is used to encrypt the data in the file system. This value is valid only if the FileSystemType parameter is set to standard or extreme. Note Extreme NAS file systems: All regions except China East 1 Finance support KMS-managed keys. General-purpose NAS file systems: All regions support KMS-managed keys.	1
SnapshotId	string	No	The snapshot ID. This parameter is available only for advanced Extreme NAS file systems. Note You can create a file system from a snapshot. In this case, the version of the file system is the same as that of the source file system. For example, the source file system of the snapshot uses version 1. To create a file system of version 2, you can create File System A from the snapshot and create File System B of version 2. You can then copy the data and migrate your business from File System A to File System B.	s-xxx
VpcId	string	No	The ID of the virtual private cloud (VPC). This parameter is required only if you set the FileSystemType parameter to cpfs. This parameter is reserved and not required if you set the FileSystemType parameter to standard or extreme.	vpc-bp1cbv1ljve4j5hlw****
VSwitchId	string	No	The vSwitch ID of the cluster. This parameter is required only if you set the FileSystemType parameter to cpfs. This parameter is reserved and not required if you set the FileSystemType parameter to standard or extreme.	vsw-2ze37k6jh8ums2fw2****
Description	string	No	The description of the file system. Limits: The description must be 2 to 128 characters in length. The description must start with a letter and cannot start with `http://` or `https://`. The description can contain letters, digits, colons (:), underscores (_), and hyphens (-).	test
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How do I ensure the idempotence? Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.	123e4567-e89b-12d3-a456-42665544****
KmsKeyId	string	No	The ID of the KMS key. This parameter is required only if the EncryptType parameter is set to 2.	3c0b3885-2adf-483d-8a65-5e280689****
DryRun	boolean	No	Specifies whether to perform a dry run. During the dry run, the system checks whether the request parameters are valid and whether the requested resources are available. During the dry run, no file system is created and no fee is incurred. Valid values: true: performs a dry run. The system checks the required parameters, request syntax, limits, and available NAS resources. If the request fails the dry run, an error message is returned. If the request passes the precheck, the HTTP status code 200 is returned. No value is returned for the FileSystemId parameter. false (default): performs a dry run and sends the request. If the request passes the dry run, a file system is created.	true
ResourceGroupId	string	No	The resource group ID. You can log on to the Resource Management console to view resource group IDs.	rg-acfmwavnfdf****
Tag	array<object>	No	An array of tags. You can specify up to 20 tags. If you specify multiple tags, each tag key must be unique.
	object	No	The tag.
Key	string	No	The tag key. Limits: The tag key cannot be null or an empty string. The tag key can be up to 128 characters in length. The tag key cannot start with `aliyun` or `acs:`. The tag key cannot contain `http://` or `https://`.	nastest
Value	string	No	The tag value. Limits: The tag value cannot be null or an empty string. The tag value can be up to 128 characters in length. The tag value cannot contain `http://` or `https://`.	testValue

Note the following about API idempotence:
The CreateFileSystem operation creates a file system and incurs fees. Therefore, if the request times out or an internal error occurs, the client may attempt to resend the request. In this case, you can specify the ClientToken parameter in the request. This ensures that the request is not repeatedly sent by the client.

Note This operation supports idempotence only if the FileSystemType parameter is set to extreme or cpfs. This operation does not support idempotence when the FileSystemType parameter is set to standard.

The following list provides more details about the ClientToken parameter.

A client token is a unique and case-sensitive string that is generated by the client. The token can contain only ASCII characters and cannot exceed 64 characters in length. Example: ClientToken=123e4567-e89b-12d3-a456-426655440000.
If you specify a used client token and modify other request parameters, NAS returns the IdempotentParameterMismatch error code.

Note The SignatureNonce, Timestamp, and Signature parameters must be changed during retries. This is because NAS uses the SignatureNonce parameter to prevent replay attacks and uses the Timestamp parameter to identify the timestamp of each request. Therefore, a retry request requires different values of the SignatureNonce and Timestamp parameters. In this case, the value of the Signature parameter changes.

If you specify the ClientToken parameter and the request fails, the request is resent based on the following HTTP status codes and error messages:
- If the HTTP status code 200 is returned, the client can receive the same result as the last request after the request is resent. However, your server status is not affected.
- If a 4xx HTTP status code is returned and the error message does not indicate "try it later", the request parameters are invalid. In this case, you must modify the request parameters based on the returned error message and then resend the request.
- If a 5xx HTTP status code is returned, a network timeout or an internal error occurred. In this case, you can resend the same request and the request must contain the same client token and request parameters.
A client token is valid for 30 days.

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	98696EF0-1607-4E9D-B01D-F20930B6****
FileSystemId	string	The ID of the file system that is created.	1ca404****

Examples

Sample success responses

JSONformat

{
  "RequestId": "98696EF0-1607-4E9D-B01D-F20930B6****",
  "FileSystemId": "1ca404****"
}

Error codes

HTTP status code	Error code	Error message	Description
202	RequestAccepted	The request has been accepted by the server.	The request has been accepted by the server.
400	IdempotentParameterMismatch	The same client token was passed in to different parameters.	The same client token was passed in to different parameters.
400	InvalidParameter.KmsServiceNotEnabled	Key Management Service is not enabled.	Key Management Service is not enabled.
400	DryRunOperation	The request is validated with DryRun flag set.	The request is validated with DryRun flag set.
400	SubAccount.NoExtremeSLRPermission	The RAM user does not have the permission to create service linked role AliyunServiceRoleForNasExtreme. Please authorize the RAM user the permission ram:CreateServiceLinkedRole.	The RAM user does not have the permission to create service linked role AliyunServiceRoleForNasExtreme. Please authorize the RAM user the permission ram:CreateServiceLinkedRole.
400	SubAccount.NoStandardSLRPermission	The RAM user does not have the permission to create service linked role AliyunServiceRoleForNasStandard. Please authorize the RAM user the permission ram:CreateServiceLinkedRole.	The RAM user does not have the permission to create service linked role AliyunServiceRoleForNasStandard. Please authorize the RAM user the permission ram:CreateServiceLinkedRole.
400	SubAccount.NoEncryptionSLRPermission	The RAM user does not have the permission to create service linked role AliyunServiceRoleForNasEncryption. Please authorize the RAM user the permission ram:CreateServiceLinkedRole.	The RAM user does not have the permission to create service linked role AliyunServiceRoleForNasEncryption. Please authorize the RAM user the permission ram:CreateServiceLinkedRole.
400	InvalidParam.NotSupportBYOK	The specified file system type does not support the BYOK encryption function.	The specified file system type does not support the BYOK encryption function.
400	MissingParameter.KmsKeyId	When parameter EncryptType equals 2, the parameter KmsKeyId is mandatory for your request.	When parameter EncryptType equals 2, the parameter KmsKeyId is mandatory for your request.
400	InvalidParameter.InvalidKmsKeyId	The specified KMS key ID is invalid.	The specified KMS key ID is invalid.
400	InvalidParameter.KmsKeyIdNotFound	The specified KMS key ID does not exist.	The specified KMS key ID does not exist.
403	OperationDenied.InvalidState	The operation is not permitted when the status is processing.	The operation is not permitted when the status is processing.
403	InvalidFileSystem.AlreadyExisted	The specified file system already exists.	The specified file system already exists.
403	Resource.OutOfStock	The inventory of the specified zone is insufficient.	The inventory of the specified zone is insufficient.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-11-12	API Description Update. The Error code has changed	View Change Details
2024-01-25	The Error code has changed	View Change Details
2023-12-26	The Error code has changed. The request parameters of the API has changed	View Change Details