Overview

Versions

Alibaba Cloud OpenAPI uses version numbers to manage the APIs for Lindorm clusters of different architectures. The following are the API versions supported by Lindorm and their descriptions.

Online debugging

Lindorm provides features such as API debugging in the OpenAPI Portal. Before you call an API, you must understand the version, endpoint description, and integration method of Lindorm. Log on to the OpenAPI Portal. In the left navigation bar, select the API version 2020-06-15. Under the region category, select the DescribeRegions API to obtain all regions that Lindorm supports. From the Service Address drop-down list, select a target region such as China (Hangzhou). In the parameter configuration section, you can set the AcceptLanguage parameter (string, example value: zh-CN). The response parameters include RequestId (string) and Regions (a list of regions). After you complete the settings, click Initiate Call.

Debugging portal

The API Explorer for Lindorm is available at API Explorer.

Endpoints

Choose the endpoint in the region where your resources are located for lower latency. For example, the VPC endpoint for the China (Qingdao) region is hitsdb-vpc.cn-qingdao.aliyuncs.com.

• Public endpoints are globally accessible.

• A Virtual Private Cloud (VPC) is an isolated virtual network. VPC endpoints offer the following benefits:

  • High security: Because VPC endpoints are accessible only from within a VPC, they provide enhanced security and privacy.

  • Faster response: By using an internal network, VPC endpoints offer faster response times than public endpoints and are not subject to public network latency or bandwidth limits.

  • Lower costs: Using VPC endpoints can reduce data transfer costs because communication occurs over an internal network.

For more information, see Endpoints.

Supported user identities

When you log in to the OpenAPI website, OpenAPI uses your logged-in account by default for online API debugging. An Alibaba Cloud account has permissions to access all APIs, which poses a high security risk. Therefore, we do not recommend that you use an Alibaba Cloud account to debug APIs online. We strongly recommend that you create and use a RAM user for API access or daily operations. Grant permissions to the RAM user as needed based on your business requirements before you make API calls. The RAM user must have permissions to operate Lindorm. For more information, see Authorization Information.

Alibaba Cloud SDK

• Alibaba Cloud provides SDKs for various programming languages, including Java, C#, Go, Python, PHP, and C++. SDKs abstract the implementation details of OpenAPI and standardize identity, authentication, and signing rules. You only need to integrate an SDK to call OpenAPI operations directly. For more information about Alibaba Cloud SDKs, see Alibaba Cloud SDK.

• You can use the Alibaba Cloud SDK to call the OpenAPI of Lindorm. For the supported languages and dependency installation methods, see SDK Installation.

Alibaba Cloud CLI

• Alibaba Cloud CLI is a command-line tool that allows you to interact with Alibaba Cloud services and manage your cloud resources by using the aliyun command in a command-line shell. For more information about Alibaba Cloud CLI, see What is Alibaba Cloud CLI?.

• You can use the Alibaba Cloud CLI to call the Lindorm OpenAPI. For more information, see Call RPC APIs.

Terraform

• Terraform is an open-source tool that you can use to securely and efficiently preview, configure, and manage cloud infrastructure and resources. Similar to Alibaba Cloud's Resource Orchestration Service (ROS), Terraform converts templates into API calls to manage resources. For more information, see What is Alibaba Cloud Terraform?.

• You can use Terraform to orchestrate and use Lindorm. For a list of supported standard and data resources, see Terraform Resource List.

Resource Orchestration Service (ROS)

• Resource Orchestration Service (ROS) is an Alibaba Cloud service that simplifies the management of cloud resources. You can create templates to define required Alibaba Cloud resources, such as ECS instances and RDS database instances, and their dependencies. The ROS orchestration engine then automatically creates and configures all resources based on the template, enabling automated deployment and O&M. For more information, see What is ROS?.

• You can use Resource Orchestration Service (ROS) to orchestrate Lindorm. For a list of supported standard and data resources, see Resource Orchestration List.

Custom encapsulation

Alternatively, you can build your own request wrapper to access Alibaba Cloud OpenAPI. This method requires you to implement the V3 signing algorithm, construct a custom request, and send it over HTTP. For more information about the signing mechanism, see V3 request body & signing mechanism.