In addition to the web-based console, ApsaraDB RDS supports programmatic resource management through OpenAPI Explorer, Alibaba Cloud SDK, Terraform, and Resource Orchestration Service (ROS). Choose the method that fits your workflow.
Overview of OpenAPI Explorer
OpenAPI Explorer lets you search, debug, and call API operations of Alibaba Cloud services. It provides intelligent search, documentation, online debugging, SDK download, sample code, error diagnosis, and call statistics. What is an API?
Version description
Alibaba Cloud APIs use version numbers to track releases. The current ApsaraDB RDS API version is 2014-08-15. This is a version identifier, not a date.
Version | Description |
Recommended |
Online debugging
Before you call API operations, note the required versions, endpoints, and integration methods.
The debugging page has three areas: a left navigation tree (APIs categorized by function), a center panel for parameter configuration and clicking Send Request, and a right panel with tabs for Documentation, Call Result, SDK Sample, and CLI Sample.
Online debugging page
You can debug the API in OpenAPI Explorer.
Endpoints
Use the endpoint that matches your instance region. For example, the China (Zhangjiakou) region uses public endpoint rds.cn-zhangjiakou.aliyuncs.com and VPC endpoint rds-vpc.cn-zhangjiakou.aliyuncs.com.
Public endpoints are accessible globally.
VPC endpoints provide the following benefits:
High security: Accessible only within a VPC.
Fast response: Data travels within the VPC, avoiding public network latency and bandwidth limits.
Low cost: Traffic stays on the internal network.
For a complete list of regional endpoints, see Endpoints.
Supported user identities
By default, OpenAPI Explorer uses your Alibaba Cloud account for debugging. Because root accounts have full API permissions, we recommend using a RAM user for API calls and routine O&M. Grant the RAM user the required ApsaraDB RDS permissions before use. Authorize a RAM user to manage ApsaraDB RDS instances.
Identity | Supported |
Yes | |
RAM user (recommended) | Yes |
RAM role (recommended) | Yes |
References
Integration methods
ApsaraDB RDS supports the following integration methods. Choose one based on your requirements.
Calling method | Supported |
Yes | |
Yes | |
Yes | |
Yes | |
Custom encapsulation | Yes |
SDKs are the most recommended method to call API operations because SDKs can be easily integrated.
-
Alibaba Cloud SDKs
Alibaba Cloud provides SDKs for Java, C#, Go, Python, TypeScript, Node.js, PHP, and C++. SDKs handle request signing, timeouts, and retries, and return structured response objects. Alibaba Cloud SDKs.
-
Supported languages and installation: ApsaraDB RDS SDK.
Alibaba Cloud CLI
Alibaba Cloud CLI lets you run
aliyuncommands to manage cloud resources. What is Alibaba Cloud CLI?Call ApsaraDB RDS API operations with CLI. Generate a command.
-
Terraform
-
Terraform is an open-source tool for provisioning and managing cloud infrastructure through templates. Similar to Resource Orchestration Service (ROS), it works by converting templates into internal data structures and then making API calls. Learn about Alibaba Cloud Terraform.
-
Supported resources and data sources: ApsaraDB RDS resources supported by Terraform.
-
ROS
ROS automates cloud resource deployment through templates. Define the resources you need (such as ECS and RDS instances) and their relationships, and ROS provisions them automatically. What is ROS?
Supported ROS resources: ApsaraDB RDS resources supported by ROS.
Custom encapsulated API calls
Native HTTP calls require manual request construction and signing. List of operations by function and Request syntax and signature method V3.
Usage notes
If an API call returns an error, verify your input parameters against the error code. Public error codes.
Record the request ID from the response or the error message from the SDK and use Alibaba Cloud OpenAPI Diagnostics for self-service diagnostics.