File Storage NAS supports multiple integration methods, including SDKs, CLI, Terraform, and direct API calls.
OpenAPI
Alibaba Cloud provides the OpenAPI Portal, an all-in-one platform for intelligent API search, documentation, online debugging, SDK downloads, code samples, error diagnosis, and call statistics. You can call OpenAPI operations for Alibaba Cloud services, view requests and responses, and generate SDK call examples. For more information, see What is OpenAPI?.
Version
Alibaba Cloud OpenAPI uses version numbers to manage API lists for cloud products. File Storage NAS currently supports API version 2017-06-26. The string 2017-06-26 is a version identifier, not a date. The API data shown is always the latest and may have changed since version 2017-06-26 was published.
|
Version |
Description |
|
Recommended |
Online debugging
The OpenAPI Portal provides API debugging tools for File Storage NAS. Before you call an API operation, familiarize yourself with the available API versions, endpoints, and integration methods.
The left navigation pane lists all File Storage NAS API operations, such as CreateFileSystem, DeleteFileSystem, and DescribeFileSystems. Select an API operation to configure its parameters in the main area, including FileSystemType, ChargeType, StorageType, and ZoneId. The right pane provides API documentation, SDK examples, and CLI examples. After you configure the parameters, click Initiate Call to test the API call.
Debugging URL
Access the API debugging page at the following URL: https://next.api.alibabacloud.com/api/NAS/2017-06-26/CreateFileSystem?tab=DOC
Endpoints
For optimal latency, select the service endpoint in the same region as your resources. For example, for resources in the China (Qingdao) region, the public endpoint for File Storage NAS is nas.cn-qingdao.aliyuncs.com and the VPC endpoint is nas-vpc.cn-qingdao.aliyuncs.com.
-
Public endpoints are globally accessible.
-
VPC endpoints are accessible only from a VPC network within the same Alibaba Cloud region. They offer several advantages:
-
Higher security: By restricting access to your VPC, these endpoints isolate traffic from the public internet.
-
Faster response times: Because VPC endpoints operate within an internal VPC network, they typically offer faster response times than public endpoints and avoid public network latency and bandwidth limitations.
-
Lower costs: Communication occurs over the internal network, which can reduce or eliminate data transfer charges.
-
For more information, see Endpoints.
Supported user identities
|
Identity |
Supported |
|
Yes |
|
|
RAM User (Recommended) |
Yes |
|
RAM Role (Recommended) |
Yes |
We recommend that you use a RAM User or a RAM Role with the minimum required permissions to make API calls.
More information
Integration methods
SDKs are the easiest and best-supported way to call OpenAPI.
File Storage NAS supports multiple integration methods, including SDKs, the Alibaba Cloud CLI, the NAS open-source toolset, Terraform, and Resource Orchestration Service (ROS). Choose the method that best suits your needs.
Alibaba Cloud SDKs
-
Alibaba Cloud provides SDKs for Java, C#, Go, Python, Node.js/TypeScript, PHP, and C++. The SDKs let you call OpenAPI operations through typed methods, handling signature logic, timeouts, and retries automatically. They return structured response objects, which simplifies development. For more information about Alibaba Cloud SDKs, see Alibaba Cloud SDKs.
-
You can use Alibaba Cloud SDKs to call File Storage NAS APIs. For supported languages and dependency installation methods, see File Storage NAS SDK.
Alibaba Cloud CLI
The Alibaba Cloud CLI lets you run the aliyun command in a terminal to interact with Alibaba Cloud services and manage cloud resources. For more information about the Alibaba Cloud CLI, see What is Alibaba Cloud CLI.
NAS open-source toolset
Alibaba Cloud NAS provides an officially supported open-source toolset on GitHub, with scripts and utilities for performance testing, mount assistance, and capacity analysis.
-
NAS capacity statistics tool (nas_stat_util)
Analyzes and collects statistics on directory-level capacity usage for a NAS file system. It supports various filtering conditions and output formats.
-
NAS/CPFS mount toolkit (alinas-utils)
A toolkit for mounting Alibaba Cloud NAS and CPFS file systems.
Visit the GitHub project page for a complete list of tools and usage instructions.
Resource Orchestration Service (ROS)
-
Resource Orchestration Service (ROS) simplifies cloud resource management. You define your Alibaba Cloud resources and their dependencies in templates, and the ROS engine automatically creates and configures them. For more information, see What is Resource Orchestration Service.
-
For the File Storage NAS resource types that ROS supports, see ROS integration examples.
Custom API encapsulation
Making raw HTTP calls requires you to implement the signing algorithm and build custom requests. For more information about the signing mechanism, see the API reference guide and V3 request body and signing mechanism.
Troubleshooting
Troubleshooting with error codes
If an API call returns an error, use the returned error code to diagnose the problem. For more information, see Error Code Center.
Self-service diagnosis
You can also record the RequestID from the API response or the SDK error information, and use the Alibaba Cloud OpenAPI Diagnostic Platform for self-service diagnosis.