This topic describes the basic information and usage notes about the AnalyticDB for MySQL API.
For more information about Alibaba Cloud APIs, see API overview.
For Data Warehouse Edition (V3.0) clusters, API operations of this version are called.
For Data Lakehouse Edition (V3.0) clusters, API operations of this version are called.
You must select an endpoint based on the region of your cluster to reduce the latency.
For example, if your cluster resides in the China (Zhangjiakou) region and is deployed in a virtual private cloud (VPC), specify
adb-vpc.cn-zhangjiakou.aliyuncs.com as the endpoint. For more information, see Endpoints.
Resource Access Management (RAM) user (recommended)
RAM role (recommended)
Alibaba Cloud SDK
For information about the programming languages supported by AnalyticDB for MySQL SDKs and the methods to install dependencies, see AnalyticDB for MySQL SDKs.
Alibaba Cloud CLI
For information about how to call the AnalyticDB for MySQL API by using Alibaba Cloud CLI, see Alibaba Cloud CLI.
Resource Orchestration Service (ROS)
For information about how to call the AnalyticDB for MySQL API by using ROS, see the ROS documentation.
For information about how to call the AnalyticDB for MySQL API by using Terraform, see the Terraform documentation.
If the preceding methods cannot meet your business requirements, you can encapsulate API requests to call API operations. However, this method is not recommended.
If an error is returned after you call an API operation, you must check whether the request parameters and their values are valid based on the returned error code. For more information, see Error codes.
You can also use the Alibaba Cloud OpenAPI Diagnostics platform to perform self-service diagnostics based on the returned request ID or SDK error information.