The following tables list the API operations that are available for use in ApsaraDB RDS.

Top 10 operations

Operation Description
CreateDBInstance Creates an RDS instance.
DescribeDBInstances Queries the RDS instances that meet specified conditions or those on which a Resource Access Management (RAM) user has permissions.
DescribeDBInstanceAttribute Queries the details about one or more RDS instances.
DescribeDBInstancePerformance Queries the performance data of an RDS instance.
DescribeSlowLogRecords Queries the slow log details of an RDS instance.
DescribeSlowLogs Queries the slow log summary of an RDS instance.
DescribeBackups Queries the data backup files of an RDS instance.
DescribeResourceUsage Queries the storage usage of an RDS instance.
CreateAccount Creates an account that is used to manage databases on an RDS instance.
CreateDatabase Creates a database on an RDS instance.

Billing management

Operation Description
DescribeAvailableResource Queries the available resources in a region.
DescribePrice Queries the price of a specific RDS instance that you want to purchase.
DescribeRenewalPrice Queries the fee that is required to renew an RDS instance.
TransformDBInstancePayType Changes the billing method of an RDS instance.
RenewInstance Renews an RDS instance.

Instance management

Operation Description
CreateDBInstance Creates an RDS instance.
DeleteDBInstance Releases an RDS instance.
RestartDBInstance Restarts an RDS instance.
ModifyDBInstanceSpec Changes the instance type or storage capacity of an RDS instance. This operation is supported for primary RDS instances and read-only RDS instances. This operation is not supported for disaster recovery RDS instances or temporary RDS instances.
ModifyDasInstanceConfig Configures automatic storage expansion for an RDS instance.
DescribeAvailableZones Queries the available resources in the zone of an RDS instance.
DescribeAvailableClasses Queries the specifications that are supported for an RDS instance. These specifications include the instance type and the storage capacity.
DescribeDBInstanceAttribute Queries the details about one or more RDS instances.
DescribeDBInstances Queries the RDS instances that meet specified conditions or those on which a RAM user has permissions.
ListClasses Queries the details about the instance types that are available to specific RDS instances.
DescribeDBInstancesByExpireTime Queries the information of the RDS instances that are configured to expire on a specific date and time.
DescribeRegions Queries the regions and zones that are available for use in ApsaraDB RDS.
MigrateToOtherZone Migrates an RDS instance across zones in the same region.
ModifyDBInstanceDescription Modifies the description of an RDS instance.
ModifyDBInstanceMaintainTime Changes the maintenance window of an RDS instance.
ModifyHADiagnoseConfig Changes the availability check method of an RDS instance.
DescribeHADiagnoseConfig Queries the availability check method of an RDS instance.
CheckInstanceExist Queries whether an RDS instance is created.
ModifyHADiagnoseConfig Changes the availability check method of an RDS instance.
DescribeHADiagnoseConfig Queries the availability check method of an RDS instance.

Database engine version upgrade

Operation Description
UpgradeDBInstanceEngineVersion Upgrades the major engine version of an RDS instance.
UpgradeDBInstanceKernelVersion Updates the minor engine version of an RDS instance.
ModifyDBInstanceAutoUpgradeMinorVersion Changes the method that is used to update the minor engine version of an RDS instance.

Network and endpoint management

Operation Description
AllocateInstancePublicConnection Allocates a public endpoint to an RDS instance.
DescribeDBInstanceNetInfo Queries the details about all the endpoints of an RDS instance.
ModifyDBInstanceConnectionString Changes an endpoint and associated port number of an RDS instance.
ModifyDBInstanceNetworkExpireTime Changes the validity period of an endpoint that is used to connect to an RDS instance.
SwitchDBInstanceNetType Switches an RDS instance between the internal endpoint and public endpoint.
ReleaseInstancePublicConnection Releases the public endpoint of an RDS instance.
ModifyDBInstanceNetworkType Changes the network type of an RDS instance.

Primary/secondary high availability and data replication

Operation Description
ModifyDBInstanceHAConfig Changes the high availability mode and data replication mode of an RDS instance.
DescribeDBInstanceHAConfig Queries the high availability mode and data replication mode of an RDS instance.
SwitchDBInstanceHA Switches the database service over between a primary RDS instance and its secondary RDS instance.
ModifyHASwitchConfig Enables or disables the automatic primary/secondary switchover feature for an RDS instance.
DescribeHASwitchConfig Queries the settings of the automatic primary/secondary switchover feature for an RDS instance.

Event history management

Operation Description
DescribeEvents Queries the events of an RDS instance.
DescribeActionEventPolicy Queries the status of the event history feature for an RDS instance.
ModifyActionEventPolicy Enables or disables the event history feature for an RDS instance.

Account management

Operation Description
CreateAccount Creates an account that is used to manage databases on an RDS instance.
DeleteAccount Deletes an account from an RDS instance.
ResetAccountPassword Resets the password of an account on an RDS instance.
LockAccount Locks an account of an RDS instance that runs PostgreSQL.
UnlockAccount Unlocks an account of an RDS instance that runs PostgreSQL.
DescribeAccounts Queries the details about the accounts that are created on an RDS instance.
ModifyAccountDescription Modifies the description of an account on an RDS instance.
GrantAccountPrivilege Grants the permissions on a database of an RDS instance to an account.
GrantOperatorPermission Grant permissions to the service account of an RDS instance.
RevokeOperationPermission Revoke permissions from the service account of an RDS instance.
RevokeAccountPrivilege Revokes the permissions on a database of an RDS instance from an account.
ResetAccount Resets the permissions of the privileged account of an RDS instance.

Database management

Operation Description
CreateDatabase Creates a database on an RDS instance.
DeleteDatabase Deletes a database from an RDS instance.
ModifyDBDescription Modifies the description of a database on an RDS instance.
CopyDatabaseBetweenInstances Replicates databases across RDS instances.
DescribeDatabases Queries the details about the databases that are created on an RDS instance.
CheckDBNameAvailable Queries whether you can create a database with a specific name on an RDS instance.
DescribeCollationTimeZones Queries the character set collations and time zones that are available for use in ApsaraDB RDS.

Read-only instance management

Operation Description
CreateReadOnlyDBInstance Creates a read-only RDS instance for a primary RDS instance.
DescribeReadDBInstanceDelay Queries the latency of data replication between a read-only RDS instance and its primary RDS instance.
ModifyReadonlyInstanceDelayReplicationTime Changes the latency of data replication between a read-only RDS instance and its primary RDS instance.

Shared proxy management (being phased-out)

Operation Description
AllocateReadWriteSplittingConnection Allocates a read/write splitting endpoint to an RDS instance.
ReleaseReadWriteSplittingConnection Releases the read/write splitting endpoint of an RDS instance.
CalculateDBInstanceWeight Queries the read weights of a primary RDS instance and its read-only RDS instances.
ModifyReadWriteSplittingConnection Changes the threshold for the latency on the read/write splitting link and the read weights of a primary RDS instance and its read-only RDS instances.
DescribeDBInstanceProxyConfiguration Queries the shared proxy settings of an RDS instance.

Dedicated proxy management (read/write splitting)

Operation Description
ModifyDBProxy Enables or disables the dedicated proxy feature for an RDS instance.
UpgradeDBProxyInstanceKernelVersion Upgrades the dedicated proxy version of an RDS instance.
ModifyDBProxyInstance Changes the number of dedicated proxy instances that are enabled on an RDS instance.
ModifyDBProxyEndpoint Modifies an endpoint that is used to connect to the dedicated proxy of an RDS instance. A proxy endpoint can be used to implement read/write splitting, transaction splitting, and connection pool.
DescribeDBProxy Queries the details about the dedicated proxy of an RDS instance.
DescribeDBProxyEndpoint Queries the endpoints that are used to connect to the dedicated proxy of an RDS instance.
DescribeDBProxyPerformance Queries the performance data of the dedicated proxy of an RDS instance.
CreateDBProxyEndpointAddress Creates an endpoint that is used to connect to the dedicated proxy of an RDS instance.
ModifyDBProxyEndpointAddress Modifies an endpoint that is used to connect to the dedicated proxy of an RDS instance.
DeleteDBProxyEndpointAddress Deletes an endpoint that is used to connect to the dedicated proxy of an RDS instance.
ModifyDbProxyInstanceSsl Configures SSL encryption for an endpoint that is used to connect to the dedicated proxy of an RDS instance.
GetDbProxyInstanceSsl Queries the SSL encryption settings of an endpoint that is used to connect to the dedicated proxy of an RDS instance.

Security and encryption

Operation Description
DescribeSecurityGroupConfiguration Queries the details about the Elastic Compute Service (ECS) security groups that are associated with an RDS instance.
ModifySecurityGroupConfiguration Modifies the ECS security groups that are associated with an RDS instance.
DescribeDBInstanceIPArrayList Queries the IP address whitelists of an RDS instance.
ModifySecurityIps Modifies an IP address whitelist of an RDS instance.
DescribeDBInstanceSSL Queries the settings of the SSL encryption feature for an RDS instance.
ModifyDBInstanceSSL Modifies the SSL link of an RDS instance.
DescribeDBInstanceTDE Queries the status of the transparent data encryption (TDE) feature for an RDS instance.
ModifyDBInstanceTDE Enables the TDE feature for an RDS instance.
MigrateSecurityIPMode Switches the network isolation mode of an RDS instance from the standard whitelist mode to the enhanced whitelist mode.
DescribeDBInstanceIpHostname Queries the hostname of the ECS instance that hosts an RDS instance.
DescribeDTCSecurityIpHostsForSQLServer Queries the distributed transaction whitelists of an RDS instance.
ModifyDTCSecurityIpHostsForSQLServer Configures a distributed transaction whitelist for an RDS instance.
DescribeDBInstanceEncryptionKey Queries the status and key of disk encryption for an RDS instance.

Log management

Operation Description
ModifySQLCollectorPolicy Enables or disables the SQL Explorer (SQL audit) feature for an RDS instance.
DescribeSQLCollectorPolicy Queries the status of the SQL Explorer (SQL audit) feature for an RDS instance.
DescribeSQLLogRecords Queries the SQL logs that are generated by the SQL Explorer (SQL audit) feature for an RDS instance.
DescribeSQLLogFiles Queries the SQL log files that are generated by the SQL Explorer (SQL audit) feature for an RDS instance.
ModifySQLCollectorRetention Modifies the SQL log retention period of an RDS instance.
DescribeSQLCollectorRetention Queries the SQL log retention period of an RDS instance.
DescribeSlowLogs Queries the slow log summary of an RDS instance.
DescribeSlowLogRecords Queries the slow log details of an RDS instance.
DescribeErrorLogs Queries the error logs of an RDS instance over a specified time range.
PurgeDBInstanceLog Deletes or compresses the SQL logs of an RDS instance.
DescribeSQLLogReports Queries the SQL log reports of an RDS instance.
DescribeSQLLogReportList Queries the SQL log reports of an RDS instance.

Backup

Operation Description
CreateBackup Creates a data backup for an RDS instance.
DescribeBackups Queries the data backup files of an RDS instance.
DescribeBackupPolicy Queries the backup settings of an RDS instance.
ModifyBackupPolicy Modifies the backup settings of an RDS instance.
DeleteBackup Deletes one or more data backup files from an RDS instance.
DescribeBackupTasks Queries the backup tasks of an RDS instance.
DescribeBinlogFiles Queries the log backup files of an RDS instance.

Restoration

Operation Description
RecoveryDBInstance Restores one or more databases of an RDS instance.
CloneDBInstance Restores the data of an RDS instance to a new RDS instance. The new RDS instance is called a cloned instance.
CreateTempDBInstance Creates a temporary RDS instance.
DescribeLocalAvailableRecoveryTime Queries the restorable time range that is supported by a backup file of an RDS instance.
RestoreTable Restores one or more databases or tables of an RDS instance to the original RDS instance.
DescribeMetaList Queries the information about the databases and tables that can be restored from a data backup file.

Cross-region backup and restoration

Operation Description
CheckCreateDdrDBInstance Checks whether the data of an RDS instance can be restored from a cross-region data backup file.
CreateDdrInstance Restores the data of an RDS instance to a new RDS instance that resides in a different region than the original RDS instance.
RestoreDdrTable Restores the data of an RDS instance to an existing RDS instance that resides in a different region than the original RDS instance.
ModifyInstanceCrossBackupPolicy Modifies the cross-region backup settings of an RDS instance.
DescribeInstanceCrossBackupPolicy Queries the cross-region backup settings of an RDS instance.
DescribeCrossBackupMetaList Queries the information about the databases and tables whose data is included in a cross-region backup file.
DescribeCrossRegionBackups Queries the cross-region data backup files of an RDS instance.
DescribeCrossRegionLogBackupFiles Queries the cross-region log backup files of an RDS instance.
DescribeAvailableCrossRegion Queries the destination regions to which the cross-region backup files from a source region can be stored.
DescribeAvailableRecoveryTime Queries the restorable time range that is supported by a cross-region backup file.
DescribeCrossRegionBackupDBInstance Queries the RDS instances for which the cross-region backup feature is enabled in a region and the cross-region backup settings of these instances.

Monitoring

Operation Description
DescribeResourceUsage Queries the storage usage of an RDS instance.
DescribeDBInstancePerformance Queries the performance data of an RDS instance.
DescribeDBInstanceMonitor Queries the monitoring frequency of an RDS instance.
ModifyDBInstanceMonitor Changes the monitoring frequency of an RDS instance.

Parameter management

Operation Description
DescribeParameters Queries the parameter settings of an RDS instance.
ModifyParameter Reconfigures the parameters of an RDS instance.
DescribeModifyParameterLog Queries the parameter reconfiguration logs of an RDS instance.
DescribeParameterTemplates Queries the parameter templates that are available to an RDS instance.
CreateParameterGroup Creates a parameter template.
ModifyParameterGroup Modifies a parameter template.
CloneParameterGroup Replicates a parameter template to the current region or to another specified region.
DescribeParameterGroups Queries the available parameter templates in a region.
DescribeParameterGroup Queries the details about a parameter template.
DeleteParameterGroup Deletes a parameter template.

Data migration

Operation Description
ImportDatabaseBetweenInstances Migrates data across RDS instances.
CancelImport Cancels a data migration task of an RDS instance that runs SQL Server.

Migration of backup files to the cloud (SQL Server)

Operation Description
CreateMigrateTask Restores the data of a backup file from an Object Storage Service (OSS) bucket to an RDS instance.
DescribeMigrateTasks Queries the backup data migration tasks of an RDS instance.
DescribeOssDownloads Queries the backup files that are included in a backup data migration task of an RDS instance.
CreateOnlineDatabaseTask Opens the databases that are included in a backup data migration task of an RDS instance. This operation is supported only by RDS instances that run SQL Server.
TerminateMigrateTask Cancels a data migration task of an RDS instance.

Tag management

Operation Description
TagResources Creates and adds tags to one or more RDS instances.
UntagResources Removes tags from one or more RDS instances.
ListTagResources Queries the tags that are added to one or more RDS instances.