CreateNASFileSystem - Elastic Desktop Service - Alibaba Cloud Documentation Center

Create a NAS file system.

Operation description

Each standard workspace can create one NAS file system to meet the need for sharing files between cloud desktops in the workspace.
The system will automatically create a general-purpose NAS file system (with storage specifications of Capacity and Performance, with capacities of 10 PiB and 1 PiB respectively) and generate a default mount point.
The NAS file system uses pay-as-you-go by default. You need to pay for the actual storage usage. You can also purchase storage packages to offset the storage usage.

For more information, see Creating Shared Storage NAS.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecd:CreateNASFileSystem

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	Region ID.	cn-hangzhou
OfficeSiteId	string	Yes	Workspace ID.	cn-hangzhou+dir-363353****
Name	string	No	Name of the NAS file system. The file name must follow these rules: Length: 2 to 128 English or Chinese characters. Must start with an uppercase or lowercase letter or a Chinese character, cannot start with http:// or https://. Can include numbers, underscores (_), or hyphens (-).	testNAS
Description	string	No	Description of the NAS file system.	testDescription
StorageType	string	No	Storage specification type of the NAS file system. Valid values: Capacity : Capacity type (default) Performance : Performance type	Capacity
EncryptType	string	No	Whether the file system is encrypted. Uses KMS service-managed keys to encrypt the file system's on-disk data. No decryption is required when reading and writing encrypted data. Valid values: 0 : Not encrypted (default) 1 : Encrypted using NAS-managed keys.	0

Response elements

Element	Type	Description	Example
	object	Return object.
FileSystemId	string	ID of the NAS file system.	04f314****
FileSystemName	string	Name of the NAS file system.	testNAS
MountTargetDomain	string	Mount point domain.	04f314**-at*.cn-hangzhou.nas.aliyuncs.com
RequestId	string	Request ID.	269BDB16-2CD8-4865-84BD-11C40BC21DB0
OfficeSiteId	string	Workspace ID.	cn-hangzhou+dir-363353****

Examples

Success response

JSON format

{
  "FileSystemId": "04f314****",
  "FileSystemName": "testNAS",
  "MountTargetDomain": "04f314****-at***.cn-hangzhou.nas.aliyuncs.com",
  "RequestId": "269BDB16-2CD8-4865-84BD-11C40BC21DB0",
  "OfficeSiteId": "cn-hangzhou+dir-363353****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.