Updated on 2024-08-28 GMT+08:00

API Overview

RDS APIs enable you to use all RDS functions, including creating DB instances, obtaining log information, and backing up and restoring data.

Type

Subtype

Description

RDS APIs (v3.1)

API v3.1 (Recommended)

Apply a parameter template, modify parameters of a specified instance, and restore data to an existing instance.

RDS APIs (v3)

Querying Version Information About APIs

Obtain API versions, including the API version list and API version information.

RDS APIs (v3)

Querying Version Information About a DB Engine

Query the DB version information of a specified DB engine.

RDS APIs (v3)

Querying Database Specifications

Query the DB specifications of a specified DB engine version.

RDS APIs (v3)

Querying the Storage Type of a Database

Query the storage type of a specified DB engine version.

RDS APIs (v3)

DB Instance Management

Manage DB instances, including creating a DB instance, adjusting instance storage space, rebooting a DB instance, deleting a DB instance, obtaining a DB instance list, and obtaining detailed information of a specified DB instance.

RDS APIs (v3)

DR Instances

Configure DR capabilities for primary and DR instances, and promote DR instances to primary.

RDS APIs (v3)

Database Security

Improve database security, including configuring SSL encryption, changing database ports, modifying security groups, and changing floating IP addresses.

RDS APIs (v3)

Backup and Restoration

Back up and restore data, including setting an automated backup policy, obtaining an automated backup policy, creating a manual backup, and deleting a manual backup.

RDS APIs (v3)

Upgrading a Major Version

Query the target version to which a DB instance can be upgraded, perform an upgrade pre-check, and query the check status or upgrade status.

RDS APIs (v3)

Log Information Queries

Obtain log information, including querying database error logs and querying database slow logs.

RDS APIs (v3)

Instance Diagnosis

Obtain the number of instances after diagnosis and obtain the result of a specific diagnosis item.

RDS APIs (v3)

SQL Statement Concurrency Control (RDS for PostgreSQL)

Add a SQL statement concurrency control rule, delete a concurrency control rule, and modify a concurrency control rule.

RDS APIs (v3)

Database Proxy (RDS for MySQL)

Enable or disable the database proxy and query database proxy information.

RDS APIs (v3)

Database and Account Management (MySQL)

Create and query databases, create, query, and delete accounts, and grant and revoke permissions of accounts.

RDS APIs (v3)

Database and Account Management (PostgreSQL)

Create and query databases, and create and query accounts.

RDS APIs (v3)

Database and Account Management (Microsoft SQL Server)

Create and query databases, create, query, and delete accounts, and grant and revoke permissions to accounts.

RDS APIs (v3)

Parameter Management

Configure parameters, including obtaining a parameter list, obtaining configuration parameter information, obtaining default parameters of a DB instance, setting configuration parameters, restoring parameters to their default values, obtaining a parameter template list, and obtaining a parameter template.

RDS APIs (v3)

Extension Management (RDS for PostgreSQL)

Create an extension, query extensions, and update an extension.

RDS APIs (v3)

Configuring Replication Delay for a Read Replica (RDS for PostgreSQL)

Obtain the delayed replay status of WAL logs and pause or resume WAL replay.

RDS APIs (v3)

Recycling a DB Instance

Modify the recycling policy, query the recycling policy, and query instances in the recycle bin.

RDS APIs (v3)

Tag Management

Manage tags, including adding tags in batches, deleting tags in batches, and querying project tags.

RDS APIs (v3)

Quota Management

Query resource quotas.

RDS APIs (v3)

Obtaining Task Information

Obtain information about a specified task in the task center.