API operations of ApsaraDB for RDS

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

Top 10 operations

Operation	Description
CreateDBInstance	Creates an RDS instance.
DescribeDBInstances	Queries one or more RDS instances that meet the specified conditions.
DescribeDBInstanceAttribute	Queries details about one or more RDS instances.
DescribeDBInstancePerformance	Queries the performance metrics of an RDS instance.
DescribeSlowLogRecords	Queries details about the slow query logs for an RDS instance.
DescribeSlowLogs	Queries the summary of the slow query logs for an RDS instance.
DescribeBackups	Queries the backup sets 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 resources available in a region.
DescribeRenewalPrice	Queries the fee that is required to renew the subscription of an RDS instance.
TransformDBInstancePayType	Changes the billing method of an RDS instance.
RenewInstance	Renews the subscription of an RDS instance.

Instance management

Operation	Description
CreateDBInstance	Creates an RDS instance.
DeleteDBInstance	Releases an RDS instance.
RestartDBInstance	Restarts an RDS instance.
ModifyDBInstanceSpec	Modifies the specifications or storage capacity of a primary or read-only RDS instance.
DescribeAvailableZones	Queries the resources available in the zone to which an RDS instance belongs.
DescribeDBInstanceAttribute	Queries details about one or more RDS instances.
DescribeDBInstances	Queries one or more RDS instances that meet the specified conditions.
DescribeRegions	Queries the regions and zones available for use in ApsaraDB for RDS.
MigrateToOtherZone	Migrates an RDS instance across zones within the same region.
ModifyDBInstanceDescription	Modifies the description of an RDS instance.
ModifyDBInstanceMaintainTime	Changes the maintenance window of an RDS instance.

Engine version upgrade

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

Endpoint management

Operation	Description
AllocateInstancePublicConnection	Allocates a public endpoint to an RDS instance.
DescribeDBInstanceNetInfo	Queries the endpoints of an RDS instance.
ModifyDBInstanceConnectionString	Modifies an endpoint and the associated port of an RDS instance.
ModifyDBInstanceNetworkExpireTime	Modifies the expiration time of an endpoint for an RDS instance.
SwitchDBInstanceNetType	Switches an RDS instance between its internal and public endpoints.
ReleaseInstancePublicConnection	Releases the public endpoint of an RDS instance.

Primary/secondary high availability and data replication

Operation	Description
ModifyDBInstanceHAConfig	Changes the high availability and data replication modes of an RDS instance.
DescribeDBInstanceHAConfig	Queries the high availability and data replication modes of an RDS instance.
SwitchDBInstanceHA	Switches services over between a primary RDS instance and its secondary instance.
ModifyHASwitchConfig	Enables or disables the automatic primary/secondary switchover function for an RDS instance.
DescribeHASwitchConfig	Queries the settings of the automatic primary/secondary switchover function 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.
UnlockAccount	Unlocks an account of an RDS instance.
DescribeAccounts	Queries 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.
RevokeAccountPrivilege	Revokes the permissions on a database of an RDS instance from an account.
ResetAccount	Resets the permissions of the privileged account on 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 details about the databases that are created on an RDS instance.
DescribeCollationTimeZones	Queries the character set collations and time zones available for use in ApsaraDB for RDS.

Read-only instance management

Operation	Description
CreateReadOnlyDBInstance	Creates a read-only instance for a primary RDS instance.
DescribeReadDBInstanceDelay	Queries the latency of data replication to a read-only RDS instance.
ModifyReadonlyInstanceDelayReplicationTime	Modifies the latency of data replication to a read-only RDS instance.

Read/write splitting

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 instances.
ModifyReadWriteSplittingConnection	Modifies the latency threshold of the read/write splitting link and the read weights of a primary RDS instance and its read-only instances.

Database proxy management

Operation	Description
ModifyDBProxy	Enables or disables the dedicated proxy feature for an RDS instance.
ModifyDBProxyInstance	Modifies the settings of the dedicated proxy feature for an RDS instance.
ModifyDBProxyEndpoint	Modifies the endpoint that is used to connect to the dedicated proxies of an RDS instance.
DescribeDBProxy	Queries details about the dedicated proxies of an RDS instance.
DescribeDBProxyEndpoint	Queries the endpoint that is used to connect to the dedicated proxies of an RDS instance.
DescribeDBProxyPerformance	Queries the performance metrics of the dedicated proxies of an RDS instance.
CreateDBProxyEndpointAddress	Creates an endpoint that is used to connect to the dedicated proxies of an RDS instance.
ModifyDBProxyEndpointAddress	Modifies the endpoint that is used to connect to the dedicated proxies of an RDS instance.
DeleteDBProxyEndpointAddress	Deletes the endpoint that is used to connect to the dedicated proxies of an RDS instance.
DescribeDBInstanceProxyConfiguration	Queries the settings of the shared proxy feature for an RDS instance.

Security and encryption

Operation	Description
DescribeSecurityGroupConfiguration	Queries 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 Secure Sockets Layer (SSL) encryption function for an RDS instance.
ModifyDBInstanceSSL	Modifies the SSL link of an RDS instance
DescribeDBInstanceTDE	Queries the status of the Transparent Data Encryption (TDE) function for an RDS instance.
ModifyDBInstanceTDE	Enables the TDE function for an RDS instance.
MigrateSecurityIPMode	Switches the network isolation mode of an RDS instance from standard whitelist to enhanced whitelist.
DescribeDBInstanceIpHostname	Queries the hostname of the ECS instance that houses an RDS instance.
DescribeDTCSecurityIpHostsForSQLServer	Queries the distributed transaction whitelists of an RDS instance.
ModifyDTCSecurityIpHostsForSQLServer	Configures a distributed transaction whitelist for an RDS instance.

Network management

Operation	Description
ModifyDBInstanceNetworkType	Changes the network type of 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 of an RDS instance.
DescribeSQLLogFiles	Queries the SQL log files of an RDS instance.
ModifySQLCollectorRetention	Modifies the SQL log storage duration of an RDS instance.
DescribeSQLCollectorRetention	Queries the SQL log storage duration of an RDS instance.
DescribeSlowLogs	Queries the summary of the slow query logs for an RDS instance.
DescribeSlowLogRecords	Queries details about the slow query logs for an RDS instance.
DescribeErrorLogs	Queries the error logs of an RDS instance over a specified time range.
PurgeDBInstanceLog	Deletes or shrinks the SQL logs of an RDS instance.

Backup

Operation	Description
CreateBackup	Creates a backup for an RDS instance.
DescribeBackups	Queries the backup sets 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, which is called a cloned instance.
CreateTempDBInstance	Creates a temporary RDS instance.
DescribeLocalAvailableRecoveryTime	Queries the restorable time of an RDS instance.
RestoreTable	Restores one or more databases or tables of an RDS instance to the same RDS instance.

Cross-region backup and restoration

Operation	Description
CheckCreateDdrDBInstance	Checks whether to allow an RDS instance to be restored by using a cross-region backup set.
CreateDdrInstance	Restores the data of an RDS instance to a new RDS instance across regions.
ModifyInstanceCrossBackupPolicy	Modifies the cross-region backup settings of an RDS instance.
DescribeInstanceCrossBackupPolicy	Queries the cross-region backup settings of an RDS instance.
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 that allow cross-region backup files from a region.
DescribeAvailableRecoveryTime	Queries the restorable time that is allowed 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.

Migration of backup files to the cloud (SQL Server)

Operation	Description
CreateMigrateTask	Restores backup files from Object Storage Service (OSS) buckets to an RDS instance.
DescribeMigrateTasks	Queries the backup data migration tasks of an RDS instance.
DescribeOssDownloads	Queries the backup files that are involved in a backup data migration task of an RDS instance.
CreateOnlineDatabaseTask	Opens the databases that are involved in a backup data migration task of an RDS instance.

Monitoring

Operation	Description
DescribeResourceUsage	Queries the storage usage of an RDS instance.
DescribeDBInstancePerformance	Queries the performance metrics of an RDS instance.
DescribeDBInstanceMonitor	Queries the monitoring frequency of an RDS instance.
ModifyDBInstanceMonitor	Modifies 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 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 parameter templates available to a region.
DescribeParameterGroup	Queries details about a parameter template.
DeleteParameterGroup	Deletes a parameter template.

Data migration

Operation	Description
ImportDatabaseBetweenInstances	Migrates data between RDS instances.
CancelImport	Cancels a migration task of an RDS instance.

Tag management

Operation	Description
TagResources	Creates and binds tags to one or more RDS instances.
UntagResources	Unbinds tags from an RDS instance.
ListTagResources	Queries the tags that are bound to one or more RDS instances.