Integration overview
Cloud Parallel File Storage (CPFS) supports four methods for managing resources programmatically: SDK, command-line interface (CLI), Terraform, and Resource Orchestration Service (ROS).
Choose an integration method
Alibaba Cloud provides OpenAPI Explorer for you to efficiently understand and use the API operations of various Alibaba Cloud services. OpenAPI Explorer integrates multiple features related to API operations, such as intelligent search, documentation, online debugging, SDK download, sample code, call error diagnostics, and call statistics. In OpenAPI Explorer, you can call the API operations of Alibaba Cloud services and view the requests and responses. OpenAPI Explorer also automatically generates the corresponding SDK sample code to facilitate the use of Alibaba Cloud services. For more information, see What is an API?.
Versions
Alibaba Cloud OpenAPI Explorer manages the versions of Alibaba Cloud service APIs by version number. For instance, CPFS supports the API of version 2017-06-26. 2017-06-26 is an API version number rather than a date. 2017-06-26 is the up-to-date version of the API, which provides the latest public information about the API.
Since CPFS and Apsara File Storage NAS (NAS) share the same SDKs. Therefore, the endpoints and SDKs of NAS are used for CPFS.
Version number | Description |
Recommended |
Online debugging
CPFS provides features such as API debugging in OpenAPI Explorer. Before you call API operations, take note of the following information provided by CPFS: versions, endpoints, and integration methods.
Debugging pages
The URL of the debugging page is Cloud Parallel File Storage (CPFS).
The following table compares the four integration methods to help you choose the one that fits your use case.
|
Method |
How it works |
When to use |
|
SDK (recommended) |
Calls OpenAPI through a language-native client library. Handles authentication, retry, and response parsing automatically. |
Building applications or automation scripts in Python, Java, Go, or other supported languages. Best for most developers. |
|
CLI |
Calls OpenAPI through a command-line tool. No coding required. |
Running one-off operations, writing shell scripts, or testing API calls interactively. |
|
Terraform |
Declares CPFS resources as infrastructure-as-code. Converts templates into OpenAPI calls. |
Managing CPFS resources alongside other cloud infrastructure in a GitOps or infrastructure-as-code (IaC) workflow. |
|
Resource Orchestration Service (ROS) |
Uses Alibaba Cloud ROS to define and deploy resource stacks from templates. |
Orchestrating CPFS resources with other Alibaba Cloud resources as part of a larger deployment stack. |
Endpoints
To minimize latency, use the endpoint for the region where your CPFS resources are located. For example, the public endpoint for CPFS in the China (Ulanqab) region is nas.cn-wulanchabu.aliyuncs.com, and the VPC endpoint is nas-vpc.cn-wulanchabu.aliyuncs.com.
Two endpoint types are available:
-
Public endpoints — accessible from anywhere, including outside Alibaba Cloud.
-
VPC endpoints — accessible only from within a virtual private cloud (VPC) in the same Alibaba Cloud region. Advantages of VPC endpoints:
-
Higher security: VPC endpoints are reachable only from within a VPC, providing stronger isolation and privacy.
-
Lower latency: VPC endpoints use internal network paths, which typically offer faster response times than public endpoints and can help you avoid issues such as Internet latency and bandwidth limitations.
-
Lower cost: VPC endpoints use internal network communication.
-
The following table lists the supported regions and endpoints for CPFS General-purpose Edition.
|
Region name |
Region ID |
Public endpoint |
VPC endpoint |
|
China (Qingdao) |
cn-qingdao |
nas.cn-qingdao.aliyuncs.com |
nas-vpc.cn-qingdao.aliyuncs.com |
|
China (Beijing) |
cn-beijing |
nas.cn-beijing.aliyuncs.com |
nas-vpc.cn-beijing.aliyuncs.com |
|
China (Zhangjiakou) |
cn-zhangjiakou |
nas.cn-zhangjiakou.aliyuncs.com |
nas-vpc.cn-zhangjiakou.aliyuncs.com |
|
China (Hohhot) |
cn-huhehaote |
nas.cn-huhehaote.aliyuncs.com |
nas-vpc.cn-huhehaote.aliyuncs.com |
|
China (Ulanqab) |
cn-wulanchabu |
nas.cn-wulanchabu.aliyuncs.com |
nas-vpc.cn-wulanchabu.aliyuncs.com |
|
China (Hangzhou) |
cn-hangzhou |
nas.cn-hangzhou.aliyuncs.com |
nas-vpc.cn-hangzhou.aliyuncs.com |
|
China (Shanghai) |
cn-shanghai |
nas.cn-shanghai.aliyuncs.com |
nas-vpc.cn-shanghai.aliyuncs.com |
|
China (Shenzhen) |
cn-shenzhen |
nas.cn-shenzhen.aliyuncs.com |
nas-vpc.cn-shenzhen.aliyuncs.com |
|
China (Heyuan) |
cn-heyuan |
nas.cn-heyuan.aliyuncs.com |
nas-vpc.cn-heyuan.aliyuncs.com |
|
China (Chengdu) |
cn-chengdu |
nas.cn-chengdu.aliyuncs.com |
nas-vpc.cn-chengdu.aliyuncs.com |
|
Singapore |
ap-southeast-1 |
nas.ap-southeast-1.aliyuncs.com |
nas-vpc.ap-southeast-1.aliyuncs.com |
User identities
User identity | Description |
Supported | |
RAM user (recommended) | Supported |
RAM role (recommended) | Supported |
We recommend that you call API operations as a Resource Access Management (RAM) user or RAM role. Before you call the API operations as a RAM user or RAM role, grant the required permissions to the RAM user or RAM role based on your business requirements.
References
Integration methods
The SDK offers the simplest setup and the best long-term support. Use it unless you have a specific reason to choose another method, such as scripting shell operations (CLI) or managing infrastructure as code (Terraform or ROS).
Alibaba Cloud SDK
Alibaba Cloud provides SDKs for multiple programming languages, such as Java, C#, Go, Python, Node.js/TypeScript, PHP, and C++. You can integrate the SDKs with your applications to directly call API operations. SDKs encapsulate information including signature logic, timeout mechanism, and retry mechanism, and return structured response objects based on specifications. This facilitates development. For more information about Alibaba Cloud SDKs, see Alibaba Cloud SDKs.
You can use Alibaba Cloud SDKs to call CPFS operations in OpenAPI Explorer. For more information about the programming languages and dependencies supported, see File Storage (NAS/CPFS) SDK and .
Alibaba Cloud CLI
The Alibaba Cloud CLI allows you to manage cloud service resources and interact with Alibaba Cloud services using the aliyun command in a command line terminal. For more information about Alibaba Cloud CLI, see What is Alibaba Cloud CLI.
Custom API encapsulation (not recommended)
To make native HTTP calls, you must construct custom requests and sign the requests on your own. For more information about the signature mechanism, see API overview and Request syntax and signature method V3.
Usage notes
If an error is returned after you call an API operation, you need to check whether the values of the request parameters are valid based on the returned error code. For more information, see Error Code Center.
You can perform self-service diagnostics based on the returned request ID or SDK error information on the Alibaba Cloud OpenAPI Diagnosis Platform.