This topic describes the API integration solutions supported by Apsara File Storage NAS (NAS).
Overview of 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 the following features for API operations: intelligent search, documentation, online debugging, SDK obtaining, sample code, error diagnostics, and call statistics. In OpenAPI Explorer, you can call API operations of Alibaba Cloud services and view API requests and responses. In addition, OpenAPI Explorer automatically generates the corresponding SDK sample code to facilitate the use of Alibaba Cloud services. For more information, see What is an API?
Version description
Alibaba Cloud OpenAPI Explorer manages the versions of Alibaba Cloud service APIs by version number. For example, NAS supports the API of the 2017-06-26
version. 2017-06-26
is an API version number but not a date. Users are provided with the latest public information about the API. 2017-06-26
is the up-to-date version of the Cloud Backup API.
API version | Description |
Recommended |
Online debugging
NAS provides features such as API debugging in OpenAPI Explorer. Before you call API operations, you must understand the following information provided by NAS: versions, endpoints, and integration methods.
Debugging page
The URL of the API debugging page is https://next.api.alibabacloud.com/api/NAS/2017-06-26/CreateFileSystem?tab=DOC.
Endpoints
Select an endpoint based on the region where your resource resides to reduce latency. For example, the public endpoint of NAS in the China (Qingdao) region is nas.cn-qingdao.aliyuncs.com
and the virtual private cloud (VPC) endpoint is nas-vpc.cn-qingdao.aliyuncs.com
.
Public endpoints can be accessed globally.
However, VPC endpoints are only accessible from within a VPC in the corresponding Alibaba Cloud region. VPC endpoints provide the following advantages:
High security: VPC endpoints can be accessed only from within a VPC. This provides higher security and privacy.
Fast response: The internal network environment delivers faster responses than those of public endpoints. In addition, problems such as network latency and bandwidth limitations can be prevented.
Low cost: VPC endpoints are accessed over an internal network.
For more information, see Endpoints.
Supported user identities
Identity | Supported or not |
Yes | |
RAM user (recommended) | Yes |
RAM role (recommended) | Yes |
We recommend that you grant only sufficient permissions to a Resource Access Management (RAM) user or RAM role and call operations as the RAM user or by assuming the RAM role.
References
Integration methods
SDKs can be easily integrated with your applications and cover the widest range of operations. We recommend that you use SDKs to call API operations.
NAS provides multiple integration methods such as SDK, command-line interface (CLI), Terraform, and Resource Orchestration Service (ROS). You can select a method based on your business requirements.
Alibaba Cloud SDKs
Alibaba Cloud provides SDKs in multiple programming languages, including Java, C#, Go, Python, Node.js, TypeScript, PHP, and C++. You can integrate SDKs into your applications to directly call API operations. SDKs encapsulate various information, including the data signing logic, timeout mechanism, and retry mechanism. SDKs return structured response objects based on specifications to facilitate development. For more information, see Alibaba Cloud SDKs.
You can use Alibaba Cloud SDKs to call the API operations of NAS. For more information about supported languages and dependencies, go to OpenAPI Portal.
Alibaba Cloud CLI
You can run aliyun
commands to interact with Alibaba Cloud services and manage cloud service resources. For more information, see What is Alibaba Cloud CLI?
ROS
ROS is an Alibaba Cloud service that simplifies the management of cloud computing resources. You can create a template to describe the required cloud computing resources such as Elastic Compute Service (ECS) and ApsaraDB RDS instances, as well as the dependencies between the resources. ROS automatically creates and configures all resources based on the template to implement automated deployment and O&M. For more information, see What is ROS?
For more information about the types of NAS resources supported by ROS, see Work with ROS.
Custom API encapsulation (not recommended)
To make native HTTP calls, you must construct custom requests and sign the requests. For information about the signature method, see List of operations by function and Request syntax and signature method V3.
Precautions
If an error is returned after you call an API operation, you must check whether the request parameters and values are valid based on the returned error code. For a list of error codes, see Service error codes.
You can also perform self-service diagnostics based on the returned request ID or SDK error information on the OpenAPI problem diagnosis page.