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

Top 10 operations

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

Billing management

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

Instances

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

Database engine version upgrade

Operation Description
UpgradeDBInstanceEngineVersion Upgrades the major engine version of an ApsaraDB RDS instance.
UpgradeDBInstanceKernelVersion Updates the minor engine version of an ApsaraDB RDS instance.
ModifyDBInstanceAutoUpgradeMinorVersion Changes the method that is used to update the minor engine version of an ApsaraDB RDS instance
UpgradeDBInstanceMajorVersionPrecheck Performs a precheck before the upgrade of the major engine version of an ApsaraDB RDS for PostgreSQL instance.
DescribeUpgradeMajorVersionPrecheckTask Queries the precheck report for a major engine version upgrade of an ApsaraDB RDS for PostgreSQL instance.
UpgradeDBInstanceMajorVersion Upgrades the major engine version of an ApsaraDB RDS for PostgreSQL instance.
DescribeUpgradeMajorVersionTasks Queries the tasks that are created to upgrade the major engine version of an ApsaraDB RDS for PostgreSQL instance.

Network and endpoint management

Operation Description
AllocateInstancePublicConnection Allocates a public endpoint to an ApsaraDB RDS instance.
DescribeDBInstanceNetInfo Queries the details about all endpoints of an ApsaraDB RDS instance.
ModifyDBInstanceConnectionString Changes an endpoint and the port number that is associated with the endpoint of an ApsaraDB RDS instance.
ModifyDBInstanceNetworkExpireTime Modifies the validity period of an endpoint that is used to connect to an ApsaraDB RDS instance.
SwitchDBInstanceNetType Switches an ApsaraDB RDS instance between the internal endpoint and the public endpoint.
ReleaseInstancePublicConnection Releases the public endpoint of an ApsaraDB RDS instance.
ModifyDBInstanceNetworkType Changes the network type of an ApsaraDB RDS instance.
SwitchDBInstanceVpc Switches an ApsaraDB RDS instance to a different VPC or a different vSwitch.
DescribeVSwitches Queries the details about a vSwitch that is created in a VPC.

Primary/secondary high availability and data replication

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

Event history management

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

Account management

Operation Description
CreateAccount Creates an account that is used to manage databases on an ApsaraDB RDS instance.
DeleteAccount Deletes an account from an ApsaraDB RDS instance.
ResetAccountPassword Resets the password of an account of an ApsaraDB RDS instance.
LockAccount Locks an account of an ApsaraDB RDS for PostgreSQL instance.
UnlockAccount Unlocks an account of an ApsaraDB RDS for PostgreSQL instance.
DescribeAccounts Queries the details about the accounts of an ApsaraDB RDS instance.
ModifyAccountDescription Modifies the description of an account of an ApsaraDB RDS instance.
DescribeInstanceKeywords Queries the reserved keywords of an ApsaraDB RDS instance. The reserved keywords cannot be used for the usernames of accounts or the names of databases.
ModifyPGHbaConfig Modifies the configuration of the pg_hba.conf file of an ApsaraDB RDS for PostgreSQL instance.
DescribePGHbaConfig Queries the configuration of the pg_hba.conf file of an ApsaraDB RDS for PostgreSQL instance.
DescribeModifyPGHbaConfigLog Queries the modification records of the pg_hba.conf file of an ApsaraDB RDS for PostgreSQL instance.
GrantAccountPrivilege Grants the permissions on a database of an ApsaraDB RDS instance to an account.
GrantOperatorPermission Grants permissions to the service account of an ApsaraDB RDS instance.
RevokeOperatorPermission Removes permissions from the service account of an ApsaraDB RDS instance.
RevokeAccountPrivilege Removes the permissions on a database of an ApsaraDB RDS instance from an account.
ResetAccount Resets the permissions of the privileged account of an ApsaraDB RDS instance.

Database management

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

Read-only instance management

Operation Description
CreateReadOnlyDBInstance Creates a read-only ApsaraDB RDS instance for a primary ApsaraDB RDS instance.
DescribeReadDBInstanceDelay Queries the latency at which a read-only ApsaraDB RDS instance replicates data from its primary ApsaraDB RDS instance.
ModifyReadonlyInstanceDelayReplicationTime Modifies the latency at which a read-only ApsaraDB RDS instance replicates data from its ApsaraDB primary RDS instance.

Shared proxy management (being phased-out)

Operation Description
AllocateReadWriteSplittingConnection Allocates a read/write splitting endpoint to an ApsaraDB RDS instance.
ReleaseReadWriteSplittingConnection Releases the read/write splitting endpoint of an ApsaraDB RDS instance.
CalculateDBInstanceWeight Queries the read weights of a primary ApsaraDB RDS instance and its read-only ApsaraDB RDS instances.
ModifyReadWriteSplittingConnection Changes the latency threshold of the read/write splitting link and the read weights of a primary ApsaraDB RDS instance and its read-only ApsaraDB RDS instances.
DescribeDBInstanceProxyConfiguration Queries the shared proxy settings of an ApsaraDB 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 ApsaraDB RDS instance.
ModifyDBProxyInstance Changes the number of dedicated proxy instances that are enabled on an ApsaraDB RDS instance.
ModifyDBProxyEndpoint Modifies an endpoint that is used to connect to the dedicated proxy of an ApsaraDB RDS instance. You can use a proxy endpoint to perform read/write splitting, transaction splitting, and connection pooling.
DescribeDBProxy Queries the details about the dedicated proxy of an ApsaraDB RDS instance.
DescribeDBProxyEndpoint Queries the proxy endpoints that are used to connect to the dedicated proxy of an ApsaraDB RDS instance.
DescribeDBProxyPerformance Queries the performance data of the dedicated proxy of an ApsaraDB RDS instance.
CreateDBProxyEndpointAddress Creates an endpoint that is used to connect to the dedicated proxy of an ApsaraDB RDS instance.
ModifyDBProxyEndpointAddress Modifies an endpoint that is used to connect to the dedicated proxy of an ApsaraDB RDS instance.
DeleteDBProxyEndpointAddress Deletes an endpoint that is used to connect to the dedicated proxy of an ApsaraDB RDS instance.
ModifyDbProxyInstanceSsl Configures SSL encryption for an endpoint that is used to connect to the dedicated proxy of an ApsaraDB RDS instance.
GetDbProxyInstanceSsl Queries the SSL encryption settings of an endpoint that is used to connect to the dedicated proxy of an ApsaraDB RDS instance.

Security and encryption

Operation Description
DescribeSecurityGroupConfiguration Queries the details about the Elastic Compute Service (ECS) security groups that are associated with an ApsaraDB RDS instance.
ModifySecurityGroupConfiguration Modifies the ECS security groups that are associated with an ApsaraDB RDS instance.
DescribeDBInstanceIPArrayList Queries the IP address whitelists of an ApsaraDB RDS instance.
ModifySecurityIps Modifies the IP address whitelist of an ApsaraDB RDS instance.
DescribeDBInstanceSSL Queries the settings of the SSL encryption feature for an ApsaraDB RDS instance.
ModifyDBInstanceSSL Modifies the SSL link of an ApsaraDB RDS instance
DescribeDBInstanceTDE Queries the status of the Transparent Data Encryption (TDE) feature for an ApsaraDB RDS instance.
ModifyDBInstanceTDE Enables the TDE feature for an ApsaraDB RDS instance.
MigrateSecurityIPMode Switches the network isolation mode of an ApsaraDB RDS instance from the standard whitelist mode to the enhanced whitelist mode.
DescribeDBInstanceIpHostname Queries the hostname of the ECS instance that hosts an ApsaraDB RDS instance.
DescribeDTCSecurityIpHostsForSQLServer Queries the distributed transaction whitelists of an ApsaraDB RDS instance.
ModifyDTCSecurityIpHostsForSQLServer Configures a distributed transaction whitelist for an ApsaraDB RDS instance.
DescribeDBInstanceEncryptionKey Queries the status of the disk encryption feature for an ApsaraDB RDS instance and the key that is used for disk encryption.
CreateServiceLinkedRole Creates a service-linked role.
ModifyDBInstanceDeletionProtection Enables or disables the release protection feature for an ApsaraDB RDS instance.

Log management

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

Backup

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

Restoration

Operation Description
RecoveryDBInstance Restores one or more databases of an ApsaraDB RDS instance.
CloneDBInstance Restores the data of an ApsaraDB RDS instance to a new ApsaraDB RDS instance. The new ApsaraDB RDS instance is called a cloned instance.
CreateTempDBInstance Creates a temporary ApsaraDB RDS instance.
DescribeLocalAvailableRecoveryTime Queries the time range within which you can restore data by using a backup file of an ApsaraDB RDS instance.
RestoreTable Restores one or more databases or tables of an ApsaraDB RDS instance to the original ApsaraDB 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 ApsaraDB RDS instance can be restored from a cross-region data backup file.
CreateDdrInstance Restores the data of an ApsaraDB RDS instance to a new ApsaraDB RDS instance that resides in a different region than the region in which the original ApsaraDB RDS instance resides.
RestoreDdrTable Restores the data of an ApsaraDB RDS instance to an existing ApsaraDB RDS instance that resides in a different region than the region in which the original ApsaraDB RDS instance resides.
ModifyInstanceCrossBackupPolicy Modifies the cross-region backup settings of an ApsaraDB RDS instance.
DescribeInstanceCrossBackupPolicy Queries the cross-region backup settings of an ApsaraDB 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 ApsaraDB RDS instance.
DescribeCrossRegionLogBackupFiles Queries the cross-region log backup files of an ApsaraDB RDS instance.
DescribeAvailableCrossRegion Queries the available destination regions to which the cross-region backup files from a specified source region can be stored.
DescribeAvailableRecoveryTime Queries the time range within which you can restore data by using a cross-region backup file.
DescribeCrossRegionBackupDBInstance Queries the ApsaraDB 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 ApsaraDB RDS instance.
DescribeDBInstancePerformance Queries the performance data of an ApsaraDB RDS instance.
DescribeDBInstanceMonitor Queries the monitoring frequency of an ApsaraDB RDS instance.
ModifyDBInstanceMonitor Modifies the monitoring frequency of an ApsaraDB RDS instance.
DescribeAvailableMetrics Queries all Enhanced Monitoring metrics that are available for an ApsaraDB RDS for PostgreSQL instance.
ModifyDBInstanceMetrics Modifies the Enhanced Monitoring metrics that are displayed for an ApsaraDB RDS for PostgreSQL instance.
DescribeDBInstanceMetrics Queries the Enhanced Monitoring metrics that are enabled for an ApsaraDB RDS for PostgreSQL instance.

Parameter management

Operation Description
DescribeParameters Queries the parameter settings of an ApsaraDB RDS instance.
ModifyParameter Reconfigures the parameters of an ApsaraDB RDS instance.
DescribeModifyParameterLog Queries the parameter reconfiguration logs of an ApsaraDB RDS instance.
DescribeParameterTemplates Queries the parameter templates that are available for an ApsaraDB 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 ApsaraDB RDS instances.
CancelImport Cancels the data migration task of an ApsaraDB RDS for SQL Server instance.

Cloud migration of backup files (ApsaraDB RDS for SQL Server)

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

Cloud migration to an ApsaraDB RDS for PostgreSQL instance

Operation Description
CreateCloudMigrationPrecheckTask Creates an assessment task for cloud migration to an ApsaraDB RDS for PostgreSQL instance.
DescribeCloudMigrationPrecheckResult Queries the assessment report for cloud migration to an ApsaraDB RDS for PostgreSQL instance.
CreateCloudMigrationTask Creates a cloud migration task for an ApsaraDB RDS for PostgreSQL instance.
ActivateMigrationTargetInstance Switches workloads over from the source PostgreSQL instance to the destination ApsaraDB RDS for PostgreSQL instance.
DescribeCloudMigrationResult Queries the details of a cloud migration task for an ApsaraDB RDS for PostgreSQL instance.

Tag management

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