This topic provides the API reference of Apsara File Storage NAS. If you are familiar with network protocols and one or more programming languages, we recommend that you use API operations to manage NAS.


You have limitations when you use NAS resources and features. For more information, see Limits on specifications.


The NAS API supports HTTP or HTTPS requests. You can use GET and POST methods to send and retrieve requests. You can call an NAS API operation by using one of the following methods:


Term Parameter Description
Region RegionId An Alibaba Cloud data center. After you create a cloud resource, you cannot change the region where the cloud resource resides.

Storage types and protocol types that are supported by NAS change based on the region.

Zone ZoneId Each zone is a physical location with independent power grids and networks in a region. Each region includes multiple zones that can communicate with each other. We recommend that you specify the same zone for a file system and a compute node on which you want to mount the file system. This eliminates extra latency for cross-zone communication between the file system and the compute node. Compute nodes include Elastic Compute Service (ECS) instances, E-HPC nodes, and Alibaba Cloud Container Service for Kubernetes (ACK) nodes.
File system FileSystemId Each NAS file system is treated as an instance of NAS. After you mount an NAS file system on a compute node, you can access the NAS file system in the same way you access a local file system.
Mount target MountTargetDomain Each mount target is an endpoint that the owner of a compute node uses to access the attached file system.
Permission group AccessGroupName Each permission group includes a set of permissions that you can use to control access to an NAS file system. You can specify the authorized IP address, data access permission, user permission, and other parameters for a permission group.
Snapshot SnapshotId Each snapshot is a recovery point that is created for a file system. Snapshots are available only for NAS Extreme file systems.
Lifecycle Name NAS supports lifecycle management. You can perform hierarchical data management. For example, you can store input data in NAS Performance file systems, while storing returned results in NAS Capacity file systems and OSS buckets. This reduces a considerable number of storage costs. You can use the File Transfer Protocol (FTP) protocol to download returned results over the Internet.
Tag Tag.N.Key Each tag includes a key-value pair. You can add tags to file systems for fast grouping and filtering.