All Products
Search

This Product

    :API overview

    Document Center

    :API overview

    Last Updated:Aug 24, 2023

    This document 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 call API operations to manage your NAS resources.

    Limits

    Some limits apply when you use NAS resources and features. For more information, see Limits.

    Methods

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

    Terms

    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 vary with different regions.

    Zone

    ZoneId

    Each zone is a physical location with independent power supplies 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 Container Service for Kubernetes (ACK) clusters.

    File system

    FileSystemId

    Each NAS file system serves as an instance of NAS. After you mount a NAS file system on a compute node, you can access the NAS file system 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 a NAS file system. You can specify the authorized IP address, read/write permissions, user permissions, and other permissions for a permission group.

    Snapshot

    SnapshotId

    Each snapshot is a recovery point that is created for a file system. Snapshots are available only for Extreme NAS file systems.

    Lifecycle

    Name

    NAS provides the lifecycle management feature. This feature provides tiered data storage. For example, you can store input data in Performance NAS file systems and store output data in Capacity NAS file systems and OSS buckets. This reduces your storage costs. You can use the File Transfer Protocol (FTP) protocol to download the output data over the Internet.

    Tag

    Tag.N.Key

    Each tag consists of a key-value pair. You can attach tags to file systems for easy search and classification.

    Appendix

    NAS supports development of SDK for Java, Python, PHP, and other programming languages. We recommend that you use an SDK. Compared with HTTP requests, an SDK eliminates the need to encapsulate HTTPS packets and generate signatures.

    You can download a language-specific SDK from one of the following GitHub links: