All Products
Search
Document Center

:Request syntax

Last Updated:Aug 14, 2023

You can call NAS API operations by sending HTTP or HTTPS requests based on URLs. Each URL must contain request parameters. This topic describes the syntax of HTTP or HTTPS requests and provides the endpoints of the NAS API.

Sample requests

The following example shows an unencoded URL request to call the CreateFileSystem operation:

http(s)://nas.cn-hangzhou.aliyuncs.com/?Action=CreateFileSystem
&EncryptType=1
&ProtocolType=NFS
&StorageType=Performance
&<Common request parameters>
  • http(s) specifies the protocol that is used for the request.

  • nas.cn-hangzhou.aliyuncs.com specifies the endpoint of the NAS API.

  • Action=CreateFileSystem specifies the API operation that you want to call. EncryptType=1, ProtocolType=NFS, and StorageType=Performance specify the parameters that are required for CreateFileSystem.

  • <Common request parameters> are common parameters defined in the system.

Protocols

You can send requests over HTTP or HTTPS. To ensure data security, we recommend that you send requests over HTTPS.

Endpoints

The following table lists the endpoints of the NAS API. To minimize the network latency, we recommend that you specify the endpoint based on the region where you make API requests.

Region

Endpoint

China (Qingdao)

nas.cn-qingdao.aliyuncs.com

China (Beijing)

nas.cn-beijing.aliyuncs.com

China (Zhangjiakou)

nas.cn-zhangjiakou.aliyuncs.com

China (Hohhot)

nas.cn-huhehaote.aliyuncs.com

China (Ulanqab)

nas.cn-wulanchabu.aliyuncs.com

China (Hangzhou)

nas.cn-hangzhou.aliyuncs.com

China (Shanghai)

nas.cn-shanghai.aliyuncs.com

China (Shenzhen)

nas.cn-shenzhen.aliyuncs.com

China (Heyuan)

nas.cn-heyuan.aliyuncs.com

China (Guangzhou)

nas.cn-guangzhou.aliyuncs.com

China (Chengdu)

nas.cn-chengdu.aliyuncs.com

China (Hong Kong)

nas.cn-hongkong.aliyuncs.com

Japan (Tokyo)

nas.ap-northeast-1.aliyuncs.com

Singapore

nas.ap-southeast-1.aliyuncs.com

Australia (Sydney)

nas.ap-southeast-2.aliyuncs.com

Malaysia (Kuala Lumpur)

nas.ap-southeast-3.aliyuncs.com

Indonesia (Jakarta)

nas.ap-southeast-5.aliyuncs.com

Philippines (Manila)

nas.ap-southeast-6.aliyuncs.com

US (Virginia)

nas.us-east-1.aliyuncs.com

US (Silicon Valley)

nas.us-west-1.aliyuncs.com

UK (London)

nas.eu-west-1.aliyuncs.com

Germany (Frankfurt)

nas.eu-central-1.aliyuncs.com

India (Mumbai)

nas.ap-south-1.aliyuncs.com

SAU (Riyadh)

nas.me-central-1.aliyuncs.com

You can use dual-stack domain names to call NAS API operations in some regions. The following table lists the regions that support dual-stack domain names and the endpoint corresponding to each region.

Region

Endpoint

China (Qingdao)

nas-dualstack.cn-qingdao.aliyuncs.com

China (Beijing)

nas-dualstack.cn-beijing.aliyuncs.com

China (Zhangjiakou)

nas-dualstack.cn-zhangjiakou.aliyuncs.com

China (Hohhot)

nas-dualstack.cn-huhehaote.aliyuncs.com

China (Ulanqab)

nas-dualstack.cn-wulanchabu.aliyuncs.com

China (Hangzhou)

nas-dualstack.cn-hangzhou.aliyuncs.com

China (Shanghai)

nas-dualstack.cn-shanghai.aliyuncs.com

China (Shenzhen)

nas-dualstack.cn-shenzhen.aliyuncs.com

China (Heyuan)

nas-dualstack.cn-heyuan.aliyuncs.com

China (Guangzhou)

nas-dualstack.cn-guangzhou.aliyuncs.com

China (Chengdu)

nas-dualstack.cn-chengdu.aliyuncs.com

Request parameters

You must set the Action parameter to the operation that you want to perform. For example, to create a file system, you must set the Action parameter to CreateFileSystem. You must also specify other operation-specific request parameters and common request parameters. For more information, see the common request parameters described in Common parameters.

Encoding

All requests and responses are encoded in UTF-8.