AnalyticDB:Integration overview

API versions

Alibaba Cloud APIs use version numbers to manage the API operations of AnalyticDB for MySQL clusters that use different architectures. Select an API version based on the edition of your AnalyticDB for MySQL cluster.

Online debugging

AnalyticDB for MySQL supports features such as online debugging in OpenAPI Explorer. Before you call API operations, make sure that you are familiar with the information about AnalyticDB for MySQL, such as the API version, endpoint, and integration method.

Debugging pages

AnalyticDB for MySQL is available in Data Warehouse Edition and Data Lakehouse Edition. Select a debugging page based on the edition of your AnalyticDB for MySQL cluster.

Endpoints

Select an endpoint based on the region in which your resource resides to reduce latency. For example, if an AnalyticDB for MySQL cluster resides in the China (Zhangjiakou) region, the public endpoint of the cluster is adb.cn-zhangjiakou.aliyuncs.com, and the Virtual Private Cloud (VPC) endpoint of the cluster is adb-vpc.cn-zhangjiakou.aliyuncs.com.

• Public endpoints can be accessed globally.

• Each VPC is a virtualized network. VPC endpoints provide the following advantages:

  • High security: VPC endpoints can be accessed only from within a VPC, which provides higher security and privacy.

  • Fast response: VPC endpoints deliver faster responses than public endpoints because VPC endpoints enable data transmission over VPCs. In addition, you can prevent issues such as network latency and bandwidth limits.

  • Low costs: VPC endpoints are accessed over an internal network.

For information about endpoints of Data Warehouse Edition, see Endpoints. For information about endpoints of Data Lakehouse Edition, see topics of specific API operations.

Supported user identities

After you log on to OpenAPI Explorer by using your Alibaba Cloud account, the system automatically uses the account for online debugging. An Alibaba Cloud account has the permissions to call all API operations. Performing online debugging by using an Alibaba Cloud account is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O&M. Before you call API operations by using a RAM user, grant the required permissions on AnalyticDB for MySQL to the RAM user based on your business requirements. For more information, see RAM authorization.

Alibaba Cloud SDKs

• Alibaba Cloud provides SDKs in multiple programming languages, including Java, C#, Go, Python, TypeScript, Node.js, PHP, and C++. Alibaba Cloud SDKs free you from considering the implementation details of API operations, such as identities, authentication information, and signature rules. You can integrate Alibaba Cloud SDKs into your applications to directly call API operations. For more information, see Alibaba Cloud SDKs.

• You can use Alibaba Cloud SDKs to call the AnalyticDB for MySQL API. For information about the supported programming languages and download links, see AnalyticDB for MySQL SDKs.

Alibaba Cloud CLI

• Alibaba Cloud CLI allows you to run aliyun commands to interact with Alibaba Cloud services and manage cloud service resources. For more information, see What is Alibaba Cloud CLI?

• You can use Alibaba Cloud CLI to call the AnalyticDB for MySQL API. For more information, see Alibaba Cloud CLI.

Terraform

• Terraform is an open source tool that you can use to securely and efficiently preview, configure, and manage cloud infrastructures and resources. Terraform works in the same manner as ROS. Terraform calls API operations by interpreting templates. For more information, see What is Terraform?

• You can use Terraform to call the AnalyticDB for MySQL API.

ROS

• ROS is an Alibaba Cloud service that helps you manage cloud computing resources in a simplified manner. You can compile stack templates to describe cloud computing resources, such as Elastic Compute Service (ECS) and ApsaraDB RDS instances, and the dependencies between the resources in the templates. The ROS engine automatically creates and configures all resources in a stack based on a template to implement automatic deployment and O&M. For more information, see What is ROS?

• You can use ROS to call the AnalyticDB for MySQL API. For more information, see ROS.

Custom encapsulation

You can encapsulate requests based on your business requirements to call Alibaba Cloud APIs. To make native HTTP calls, you must construct custom requests and sign the requests. For information about the signature method, see Request syntax and signature method V3.