This topic describes the integration solutions supported by Cloud Parallel File Storage (CPFS) for Lingjun.
OpenAPI Explorer
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 File Storage NAS.
Endpoints
Select an endpoint based on the region in which your resources reside to reduce latency. For example, the public endpoint of CPFS in the China (Ulanqab) region is nas.cn-wulanchabu.aliyuncs.com, and the Virtual Private Cloud (VPC) endpoint is nas-vpc.cn-wulanchabu.aliyuncs.com.
Public endpoints are accessible globally.
A VPC endpoint is accessible only from VPCs in a specific Alibaba Cloud region. VPC endpoints provide the following benefits:
High security: VPC endpoints can be accessed only within a VPC. This provides higher security and privacy.
Faster response: VPC endpoints use the internal network environment to deliver faster responses than public endpoints. In addition, you are free from issues such as network latency and bandwidth limits.
Lower cost: VPC endpoints are accessed over an internal network.
The following table lists the regions and endpoints supported by CPFS for Lingjun.
Region name | Region ID | Public endpoint | VPC endpoint |
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
You can integrate SDKs into your applications with ease. SDKs cover the widest range of operations. We recommend that you use SDKs to call API operations.
CPFS for Lingjun provides integration methods such as SDK and command-line interface (CLI). You can select a method based on your business requirements.
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 and File Storage NAS SDK.
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 List of operations by function 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 OpenAPI problem diagnosis.