ApsaraDB RDS:Integration overview

API version

ApsaraDB RDS uses version numbers to identify API releases. The current version is 2014-08-15 — this is a version identifier, not a date. Use this version for all new integrations.

Debugging entrypoint: Debug API

Endpoints

Use the endpoint for the region where your instance resides to minimize latency.

For example, for an instance in the China (Zhangjiakou) region:

• Public endpoints are accessible from anywhere.

• VPC endpoints are accessible only within the virtual private cloud (VPC), which provides higher security, lower latency, and lower cost through internal network access.

For the full list of regional endpoints, see Endpoints.

Authentication

OpenAPI Explorer authenticates using your Alibaba Cloud identity. Alibaba Cloud account credentials have full access to all API operations, which poses a security risk. Use a RAM user or RAM role instead.

Grant the RAM user or role only the permissions required to manage ApsaraDB RDS resources. See Authorize a RAM user to manage ApsaraDB RDS instances.

For identity types, credentials, and authorization details, see Identity, credential, and authorization. For API rate limits and quotas, see Throttling and quota management.

Alibaba Cloud SDK

Alibaba Cloud SDKs handle request signing, timeout management, and retry logic so you can call API operations directly without constructing raw HTTP requests. SDKs return structured response objects.

Supported languages: Java, Python, Go, Node.js, TypeScript, C#, PHP, and C++.

To get started, go to OpenAPI Explorer and select your language to view dependencies and installation instructions.

For an overview of all supported languages, see Alibaba Cloud SDKs.

Alibaba Cloud CLI

Alibaba Cloud CLI lets you manage RDS resources from the command line using the aliyun command. It is suited for shell scripts and CI/CD pipelines.

To call ApsaraDB RDS API operations from the CLI, see Generate a command. For a CLI overview, see What is Alibaba Cloud CLI?

ROS

ROS (Resource Orchestration Service) lets you define ApsaraDB RDS instances and related resources such as Elastic Compute Service (ECS) instances in a template. ROS creates and configures all resources automatically from the template.

For supported RDS resource types, see ApsaraDB RDS resources supported by ROS. For a ROS overview, see What is ROS?

Terraform

Terraform manages ApsaraDB RDS resources through the Alibaba Cloud provider using HCL configuration files. It integrates with standard Terraform workflows and state management.

For Terraform integration with Alibaba Cloud services, see Terraform.

Direct HTTP calls

To call API operations without an SDK, construct HTTP requests manually and sign them using the V3 signature method. For the signature specification, see Request syntax and signature method V3.