All Products
Search
Document Center

File Storage NAS:Integration overview

Last Updated:Dec 15, 2025

This topic describes the integration solutions for File Storage NAS (NAS).

Introduction to OpenAPI

To help developers learn and use cloud product APIs quickly and efficiently, Alibaba Cloud provides the OpenAPI website. This all-in-one platform features intelligent API search, documentation, online debugging, SDK downloads, code samples, error diagnosis, and usage statistics. The OpenAPI portal lets you call public APIs for various Alibaba Cloud products, view requests and responses, and automatically generate SDK code examples. For more information, see What is OpenAPI?.

API version

Alibaba Cloud OpenAPI uses version numbers to manage API lists for major product versions. For example, NAS currently supports the 2017-06-26 API version. This number is an API version identifier, not a date. The APIs for this version are always the latest available, not a snapshot frozen on that date.

API version

Description

2017-06-26

Recommended

Online debugging

Before calling an API, understand the available versions, endpoints, and integration methods for NAS.

image

Debugging page

Access the API debugging page at the following URL: https://next.api.alibabacloud.com/api/NAS/2017-06-26/CreateFileSystem?tab=DOC

Endpoints

For the lowest latency, select the service endpoint in the same region as your resources. For example, in the China North 1 (Qingdao) region, the public and Virtual Private Cloud (VPC) endpoints for NAS are nas.cn-qingdao.aliyuncs.com and nas-vpc.cn-qingdao.aliyuncs.com, respectively.

  • Public endpoints are accessible globally.

  • VPC endpoints are accessible only from within the corresponding Alibaba Cloud region and VPC network. The advantages of using a VPC endpoint include:

    • High security: VPC endpoints are accessible only from within a VPC, offering greater security and privacy.

    • Faster response times: Because VPC endpoints operate within the internal VPC network, they typically offer faster response times than public endpoints, avoiding public network latency and bandwidth limitations.

    • Lower costs: VPC endpoints use internal network communication, which avoids public data transfer fees.

For more information, see Endpoints.

Supported user identities

Identity

Supported or not

Alibaba Cloud account

Yes

RAM User (Recommended)

Yes

RAM Role (Recommended)

Yes

We recommend using a RAM User or RAM Role. Grant permissions on demand before calling APIs.

More information

Integration methods

Note

We recommend using SDKs, as they are the easiest and best-supported method for calling APIs.

NAS provides 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 business needs.

Alibaba Cloud SDKs

  • Alibaba Cloud provides SDKs for various programming languages, including Java, C#, Go, Python, Node.js/TypeScript, PHP, and C++. Integrate an SDK to call APIs directly through its methods. The SDKs handle the signature logic, timeout mechanism, and retry mechanism. They also return structured response objects based on the documentation, which simplifies development. For more information about Alibaba Cloud SDKs, see Alibaba Cloud SDKs.

  • You can call NAS APIs through Alibaba Cloud SDKs. For supported languages and dependency installation methods, see OpenAPI Portal.

Alibaba Cloud CLI

The Alibaba Cloud Command-Line Interface (CLI) allows you to interact with Alibaba Cloud services and manage your cloud service resources from a command-line terminal by using the

aliyun

command. For more information about the Alibaba Cloud CLI, see What is Alibaba Cloud CLI?.

NAS open-source toolset

Alibaba Cloud NAS maintains an official open-source toolset on GitHub. This toolset includes various scripts and utilities for tasks such as performance tests, mount assistance, and capacity analysis. Deploy and run these tools directly in your environment to simplify daily operations and testing.

  • NAS capacity statistics tool (nas_stat_util)

    Analyzes and provides statistics on directory-level capacity usage for a NAS file system. It supports filtering conditions and output formats.

  • NAS/CPFS mount toolkit (alinas-utils)

    A toolkit to help mount Alibaba Cloud NAS/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) is an Alibaba Cloud service that simplifies cloud resource management. Developers and administrators can create templates to define required Alibaba Cloud resources, such as Elastic Compute Service (ECS) instances and RDS database instances, and their dependencies. The ROS orchestration engine automatically creates and configures all resources based on the template, enabling automated deployment and operations. For more information, see What is ROS?.

  • See Work with ROS for the NAS resource types that ROS supports.

Custom API encapsulation (not recommended)

Native HTTP calls require you to implement the signing algorithm, build custom requests, and initiate the HTTP calls. For more information about the signing mechanism, see API reference guide and V3 request body and signing mechanism.

FAQ

How do I troubleshoot API failures using an error code?

When an API call fails, the response contains an Error Code. Use this code to identify issues with your request parameters or values. For a complete list of codes and their solutions, refer to Service error codes.

How can I diagnose a failed API call using its RequestID?

Perform a self-service diagnosis by using the RequestID from the API response or the error message from the SDK. Submit this information to the OpenAPI problem diagnosis platform for a detailed analysis of the failure.