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

Top 10 operations

OperationDescription
CreateDBInstanceCreates an ApsaraDB RDS instance.
DescribeDBInstancesQueries the ApsaraDB RDS instances that meet specified conditions or the ApsaraDB RDS instances on which a specified RAM user has permissions.
DescribeDBInstanceAttributeQueries the details about one or more ApsaraDB RDS instances.
DescribeDBInstancePerformanceQueries the performance data of an ApsaraDB RDS instance.
DescribeSlowLogRecordsQueries the details about the slow query logs of an ApsaraDB RDS instance.
DescribeSlowLogsQueries the summary of the slow query logs of an ApsaraDB RDS instance.
DescribeBackupsQueries the data backup files of an ApsaraDB RDS instance.
DescribeResourceUsageQueries the storage usage of an ApsaraDB RDS instance.
CreateAccountCreates an account to manage databases on an ApsaraDB RDS instance.
CreateDatabaseCreates a database on an ApsaraDB RDS instance.

Billing

OperationDescription
DescribePriceQueries the price of an ApsaraDB RDS instance.
DescribeRenewalPriceQueries the renewal fee for an ApsaraDB RDS instance.
TransformDBInstancePayTypeChanges the billing method of an ApsaraDB RDS instance.
RenewInstanceRenews an ApsaraDB RDS instance.

Instances

OperationDescription
CreateDBInstanceCreates an ApsaraDB RDS instance.
DeleteDBInstanceReleases an ApsaraDB RDS instance.
RestartDBInstanceRestarts an instance.
ModifyDBInstanceSpecChanges 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.
ModifyDasInstanceConfigConfigures automatic storage expansion for an ApsaraDB RDS instance.
DescribeAvailableZonesQueries the available resources in the zone in which an ApsaraDB RDS instance resides.
DescribeAvailableClassesQueries the specifications that are supported for an ApsaraDB RDS instance. The specifications include the instance type and the storage capacity.
DescribeDBInstanceAttributeQueries the details about one or more ApsaraDB RDS instances.
GetDBInstanceTopologyQueries the topology of an ApsaraDB RDS instance.
DescribeDBInstancesQueries the ApsaraDB RDS instances that meet specified conditions or the ApsaraDB RDS instances on which a specified RAM user has permissions.
ListClassesQueries the details about the available instance types.
DescribeDBInstancesByExpireTimeQueries the information about the RDS instances that expire on a specified date.
DescribeRegionsQueries the regions and zones that are available for use in ApsaraDB RDS.
MigrateToOtherZoneMigrates an ApsaraDB RDS instance across zones in the same region.
ModifyDBInstanceDescriptionModifies the description of an ApsaraDB RDS instance.
ModifyDBInstanceMaintainTimeModifies the maintenance window of an RDS instance.
CheckInstanceExistQueries whether an ApsaraDB RDS instance is created.
ModifyHADiagnoseConfigChanges the availability check method of an ApsaraDB RDS instance.
DescribeHADiagnoseConfigQueries the availability check method of an ApsaraDB RDS instance.
DescribeAnalyticdbByPrimaryDBInstanceQueries the analytic instances that are associated with an ApsaraDB RDS for MySQL instance.
CheckCloudResourceAuthorizedQueries cloud resource permissions.

Upgrades of database engine versions

OperationDescription
UpgradeDBInstanceEngineVersionUpgrades the major engine version of an ApsaraDB RDS instance.
UpgradeDBInstanceKernelVersionUpdates the minor engine version of an ApsaraDB RDS instance.
ModifyDBInstanceAutoUpgradeMinorVersionChanges the method that is used to update the minor engine version of an ApsaraDB RDS instance.
UpgradeDBInstanceMajorVersionPrecheckChecks the compatibility between a new major engine version and an ApsaraDB RDS for PostgreSQL instance before an upgrade.
DescribeUpgradeMajorVersionPrecheckTaskQueries the check report for a major engine version upgrade of an ApsaraDB RDS for PostgreSQL instance.
UpgradeDBInstanceMajorVersionUpgrades the major engine version of an ApsaraDB RDS for PostgreSQL instance.
DescribeUpgradeMajorVersionTasksQueries the tasks that are created to upgrade the major engine version of an ApsaraDB RDS for PostgreSQL instance.

Networks and endpoints

OperationDescription
AllocateInstancePublicConnectionApplies for a public endpoint for an ApsaraDB RDS instance.
DescribeDBInstanceNetInfoQueries the details about all endpoints of an ApsaraDB RDS instance.
ModifyDBInstanceConnectionStringChanges the endpoint and the port number of an ApsaraDB RDS instance.
ModifyDBInstanceNetworkExpireTimeModifies the validity period of an endpoint of an ApsaraDB RDS instance.
SwitchDBInstanceNetTypeSwitches an ApsaraDB RDS instance between the internal endpoint and the public endpoint.
ReleaseInstancePublicConnectionReleases the public endpoint of an ApsaraDB RDS instance.
ModifyDBInstanceNetworkTypeChanges the network type of an ApsaraDB RDS instance.
SwitchDBInstanceVpcChanges the virtual private cloud (VPC) or vSwitch of an ApsaraDB RDS instance.
DescribeVSwitchesQueries the details about a vSwitch that is created in a VPC.

Primary/secondary high availability and data replication

OperationDescription
ModifyDBInstanceHAConfigChanges the high-availability mode and data replication mode of an ApsaraDB RDS instance.
DescribeDBInstanceHAConfigQueries the high-availability mode and data replication mode of an ApsaraDB RDS instance.
SwitchDBInstanceHASwitches workloads over between a primary RDS instance and its secondary RDS instance.
ModifyHASwitchConfigEnables or disables the automatic primary/secondary switchover feature for an ApsaraDB RDS instance.
DescribeHASwitchConfigQueries the settings of the automatic primary/secondary switchover feature for an ApsaraDB RDS instance.

Event history

OperationDescription
DescribeEventsQueries the events of an ApsaraDB RDS instance.
DescribeActionEventPolicyQueries the status of the event history feature for an ApsaraDB RDS instance.
ModifyActionEventPolicyEnables or disables the event history feature for an ApsaraDB RDS instance.

Notifications

OperationDescription
QueryNotifyQueries the notifications of an ApsaraDB RDS instance.
ModifyActionEventPolicyEnables or disables the event history feature for an ApsaraDB RDS instance.

Accounts

OperationDescription
CreateAccountCreates an account to manage databases on an ApsaraDB RDS instance.
DeleteAccountDeletes an account from an ApsaraDB RDS instance.
ResetAccountPasswordResets the password of an account of an ApsaraDB RDS instance.
LockAccountLocks an account of an ApsaraDB RDS for PostgreSQL instance.
UnlockAccountUnlocks an account of an ApsaraDB RDS for PostgreSQL instance.
DescribeAccountsQueries the details about the accounts that are created on an ApsaraDB RDS instance.
ModifyAccountDescriptionModifies the description of an account of an ApsaraDB RDS instance.
DescribeInstanceKeywordsQueries the reserved keywords of an ApsaraDB RDS instance. The reserved keywords cannot be used for the usernames of accounts or the names of databases.
ModifyPGHbaConfigModifies the pg_hba.conf file of an ApsaraDB RDS for PostgreSQL instance.
DescribePGHbaConfigQueries the configuration of the pg_hba.conf file of an ApsaraDB RDS for PostgreSQL instance.
DescribeModifyPGHbaConfigLogQueries the details about the modifications to the pg_hba.conf file of an ApsaraDB RDS for PostgreSQL instance.
GrantAccountPrivilegeGrants the permissions on a database of an ApsaraDB RDS instance to an account.
GrantOperatorPermissionGrants permissions to the service account of an ApsaraDB RDS instance.
RevokeOperatorPermissionRemoves permissions from the service account of an ApsaraDB RDS instance.
RevokeAccountPrivilegeRemoves the permissions on a database of an ApsaraDB RDS instance from an account.
ResetAccountResets the permissions of the privileged account of an ApsaraDB RDS instance.

Databases

OperationDescription
CreateDatabaseCreates a database on an ApsaraDB RDS instance.
DeleteDatabaseDeletes a database from an ApsaraDB RDS instance.
ModifyDBDescriptionModifies the description of a database on an ApsaraDB RDS instance.
CopyDatabaseBetweenInstancesReplicates databases across RDS instances.
DescribeDatabasesQueries the details about the databases that are created on an ApsaraDB RDS instance.
CheckDBNameAvailableQueries whether a database name can be used on an ApsaraDB RDS instance.
DescribeCollationTimeZonesQueries the character set collations and time zones that are available for use in ApsaraDB RDS.
DescribeCharacterSetNameQueries the character sets that are supported by an ApsaraDB RDS instance.

Read-only instances

OperationDescription
CreateReadOnlyDBInstanceCreates a read-only ApsaraDB RDS instance for a primary ApsaraDB RDS instance.
DescribeReadDBInstanceDelayQueries the latency at which a read-only ApsaraDB RDS instance replicates data from its primary ApsaraDB RDS instance.
ModifyReadonlyInstanceDelayReplicationTimeChanges the latency at which a read-only ApsaraDB RDS instance replicates data from its ApsaraDB primary RDS instance.

Shared proxy (being phased-out)

OperationDescription
AllocateReadWriteSplittingConnectionApplies for a read/write splitting endpoint for an ApsaraDB RDS instance.
ReleaseReadWriteSplittingConnectionReleases the read/write splitting endpoint of an ApsaraDB RDS instance.
CalculateDBInstanceWeightQueries the system-assigned read weights.
ModifyReadWriteSplittingConnectionChanges 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.
DescribeDBInstanceProxyConfigurationQueries the shared proxy settings of an ApsaraDB RDS instance.

Dedicated proxy (read/write splitting)

OperationDescription
ModifyDBProxyEnables or disables the dedicated proxy feature for an ApsaraDB RDS instance.
UpgradeDBProxyInstanceKernelVersionUpgrades the dedicated proxy version of an ApsaraDB RDS instance.
ModifyDBProxyInstanceChanges the number of dedicated proxies that are enabled on an ApsaraDB RDS instance.
ModifyDBProxyEndpointModifies 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.
DescribeDBProxyQueries the details about the dedicated proxy of an ApsaraDB RDS instance.
DescribeDBProxyEndpointQueries the endpoints that are used to connect to the dedicated proxy of an ApsaraDB RDS instance.
DescribeDBProxyPerformanceQueries the performance data of the dedicated proxy of an ApsaraDB RDS instance.
CreateDBProxyEndpointAddressCreates an endpoint that is used to connect to the dedicated proxy of an ApsaraDB RDS instance.
ModifyDBProxyEndpointAddressModifies an endpoint that is used to connect to the dedicated proxy of an ApsaraDB RDS instance.
DeleteDBProxyEndpointAddressDeletes an endpoint that is used to connect to the dedicated proxy of an ApsaraDB RDS instance.
ModifyDbProxyInstanceSslConfigures SSL encryption for an endpoint that is used to connect to the dedicated proxy of an ApsaraDB RDS instance.
GetDbProxyInstanceSslQueries the SSL encryption settings of an endpoint that is used to connect to the dedicated proxy of an ApsaraDB RDS instance.

Security and encryption

OperationDescription
DescribeSecurityGroupConfigurationQueries the details about the Elastic Compute Service (ECS) security groups that are associated with an ApsaraDB RDS instance.
ModifySecurityGroupConfigurationModifies the ECS security groups that are associated with an ApsaraDB RDS instance.
DescribeDBInstanceIPArrayListQueries the IP address whitelists of an ApsaraDB RDS instance.
ModifySecurityIpsModifies an IP address whitelist of an ApsaraDB RDS instance.
DescribeDBInstanceSSLQueries the settings of the SSL encryption feature for an ApsaraDB RDS instance.
ModifyDBInstanceSSLModifies the SSL link of an ApsaraDB RDS instance.
DescribeDBInstanceTDEQueries the status of the Transparent Data Encryption (TDE) feature for an ApsaraDB RDS instance.
ModifyDBInstanceTDEEnables the TDE feature for an ApsaraDB RDS instance.
MigrateSecurityIPModeChanges the network isolation mode of an ApsaraDB RDS instance from the standard whitelist mode to the enhanced whitelist mode.
DescribeDBInstanceIpHostnameQueries the hostname of the ECS instance on which an ApsaraDB RDS instance runs.
DescribeDTCSecurityIpHostsForSQLServerQueries the distributed transaction whitelists of an ApsaraDB RDS instance.
ModifyDTCSecurityIpHostsForSQLServerConfigures a distributed transaction whitelist for an ApsaraDB RDS instance.
DescribeDBInstanceEncryptionKeyQueries the status of the disk encryption feature for an ApsaraDB RDS instance and the key that is used for disk encryption.
CreateServiceLinkedRoleCreates a service-linked role.
ModifyDBInstanceDeletionProtectionEnables or disables the release protection feature for an ApsaraDB RDS instance.

Logs

OperationDescription
ModifySQLCollectorPolicyEnables or disables the SQL Explorer (SQL Audit) feature for an ApsaraDB RDS instance.
DescribeSQLCollectorPolicyQueries the status of the SQL Explorer (SQL Audit) feature for an ApsaraDB RDS instance.
DescribeSQLLogRecordsQueries the audit logs that are generated by the SQL Explorer (SQL Audit) feature for an ApsaraDB RDS instance.
DescribeSQLLogFilesQueries the audit log files that are generated by the SQL Explorer (SQL Audit) feature for an ApsaraDB RDS instance.
ModifySQLCollectorRetentionModifies the retention period of the audit log files that are generated by the SQL Explorer feature for an ApsaraDB RDS instance.
DescribeSQLCollectorRetentionQueries the retention period of the audit log files that are generated by the SQL Explorer feature for an ApsaraDB RDS instance.
DescribeSlowLogsQueries the summary of the slow query logs of an ApsaraDB RDS instance.
DescribeSlowLogRecordsQueries the details about the slow query logs of an ApsaraDB RDS instance.
DescribeErrorLogsQueries the error logs of an ApsaraDB RDS instance over a specific time range.
PurgeDBInstanceLogDeletes or compresses the logs of an ApsaraDB RDS instance.
DescribeSQLLogReportsQueries the SQL log report of an ApsaraDB RDS instance.
DescribeSQLLogReportListQueries the SQL log reports of an ApsaraDB RDS instance.

Backups

OperationDescription
CreateBackupCreates a data backup for an ApsaraDB RDS instance.
DescribeBackupsQueries the data backup files of an ApsaraDB RDS instance.
DescribeDetachedBackupsQueries the data backup files of an ApsaraDB RDS instance that is deleted.
DescribeBackupPolicyQueries the backup settings of an ApsaraDB RDS instance.
ModifyBackupPolicyModifies the backup settings of an ApsaraDB RDS instance.
DeleteBackupDeletes one or more data backup files from an ApsaraDB RDS instance.
DescribeBackupTasksQueries the backup tasks of an ApsaraDB RDS instance.
DescribeBinlogFilesQueries the binary log files of an ApsaraDB RDS instance.

Restoration

OperationDescription
RecoveryDBInstanceRestores one or more databases of an ApsaraDB RDS instance.
CloneDBInstanceRestores the data of an ApsaraDB RDS instance to a new RDS instance. The new RDS instance is called a cloned instance.
CreateTempDBInstanceCreates a temporary ApsaraDB RDS instance.
DescribeLocalAvailableRecoveryTimeQueries the time range within which you can restore data by using a backup file of an ApsaraDB RDS instance.
RestoreTableRestores one or more databases or tables of an ApsaraDB RDS instance to the original ApsaraDB RDS instance.
DescribeMetaListQueries information about the databases and tables that can be restored from a data backup file.

Cross-region backup and restoration

OperationDescription
CheckCreateDdrDBInstanceChecks whether the data of an ApsaraDB RDS instance can be restored by using a cross-region data backup file.
CreateDdrInstanceRestores 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.
RestoreDdrTableRestores the data of an ApsaraDB RDS instance to an existing RDS instance that resides in a different region than the region in which the original ApsaraDB RDS instance resides.
ModifyInstanceCrossBackupPolicyModifies the cross-region backup settings of an ApsaraDB RDS instance.
DescribeInstanceCrossBackupPolicyQueries the cross-region backup settings of an ApsaraDB RDS instance.
DescribeCrossBackupMetaListQueries information about the databases and tables whose data is included in a cross-region backup file.
DescribeCrossRegionBackupsQueries the cross-region data backup files of an ApsaraDB RDS instance.
DescribeCrossRegionLogBackupFilesQueries the cross-region log backup files of an ApsaraDB RDS instance.
DescribeAvailableCrossRegionQueries the available destination regions to which the cross-region backup files from a specific source region can be replicated.
DescribeAvailableRecoveryTimeQueries the time range within which you can restore data by using a cross-region backup file.
DescribeCrossRegionBackupDBInstanceQueries 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

OperationDescription
DescribeResourceUsageQueries the storage usage of an ApsaraDB RDS instance.
DescribeDBInstancePerformanceQueries the performance data of an ApsaraDB RDS instance.
DescribeDBInstanceMonitorQueries the monitoring frequency of an ApsaraDB RDS instance.
ModifyDBInstanceMonitorModifies the monitoring frequency of an ApsaraDB RDS instance.
DescribeAvailableMetricsQueries all enhanced monitoring metrics that are available to an ApsaraDB RDS for PostgreSQL instance.
ModifyDBInstanceMetricsModifies the enhanced monitoring metrics that are displayed for an ApsaraDB RDS for PostgreSQL instance
DescribeDBInstanceMetricsQueries the enhanced monitoring metrics that are enabled for an ApsaraDB RDS for PostgreSQL instance.

Parameters

OperationDescription
DescribeParametersQueries the parameter settings of an ApsaraDB RDS instance.
ModifyParameterModifies the parameters of an ApsaraDB RDS instance.
DescribeModifyParameterLogQueries the parameter modification logs of an ApsaraDB RDS instance.
DescribeParameterTemplatesQueries the parameter templates that are available to an ApsaraDB RDS instance.
CreateParameterGroupCreates a parameter template.
ModifyParameterGroupModifies a parameter template.
CloneParameterGroupReplicates a parameter template to the current region or to another region.
DescribeParameterGroupsQueries the available parameter templates in a region.
DescribeParameterGroupQueries the details about a parameter template.
DeleteParameterGroupDeletes a parameter template.

Data migration

OperationDescription
ImportDatabaseBetweenInstancesMigrates data across ApsaraDB RDS instances.
CancelImportCancels a data migration task of an ApsaraDB RDS for SQL Server instance.

Cloud migration of backup files (SQL Server)

OperationDescription
CreateMigrateTaskRestores the data of a backup file from an Object Storage Service (OSS) bucket to an ApsaraDB RDS instance.
DescribeMigrateTasksQueries the backup data migration tasks of an ApsaraDB RDS instance.
DescribeOssDownloadsQueries the backup files that are included in a backup data migration task of an ApsaraDB RDS instance.
CreateOnlineDatabaseTaskOpens the database that is included in a backup data migration task of an ApsaraDB RDS for SQL Server instance.
DescribeMigrateTaskByIdQueries a single task that is used to migrate the backup data of an ApsaraDB RDS for SQL Server instance to an OSS bucket.
TerminateMigrateTaskCancels a data migration task of an ApsaraDB RDS instance.

AD domains for ApsaraDB RDS for SQL Server

OperationDescription
ModifyADInfoModifies the AD domain information about an ApsaraDB RDS for SQL Server instance.
DeleteADSettingDeletes the AD domain information about an ApsaraDB RDS for SQL Server instance.
DescribeADInfoQueries the AD domain information of about ApsaraDB RDS for SQL Server instance.

Cluster management for ApsaraDB RDS for SQL Server

OperationDescription
AllocateReadWriteSplittingConnectionApplies for a read/write splitting endpoint for an ApsaraDB RDS instance.
ReleaseReadWriteSplittingConnectionReleases the read/write splitting endpoint of an ApsaraDB RDS instance.
CalculateDBInstanceWeightQueries the system-assigned read weights.
ModifyReadWriteSplittingConnectionChanges 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.

Cloud migration to an ApsaraDB RDS for PostgreSQL instance

OperationDescription
CreateCloudMigrationPrecheckTaskCreates an assessment task for cloud migration to an ApsaraDB RDS for PostgreSQL instance.
DescribeCloudMigrationPrecheckResultQueries the assessment report for cloud migration to an ApsaraDB RDS for PostgreSQL instance.
CreateCloudMigrationTaskCreates a cloud migration task for an ApsaraDB RDS for PostgreSQL instance.
ActivateMigrationTargetInstanceSwitches workloads over from the source PostgreSQL instance to the destination ApsaraDB RDS for PostgreSQL instance.
DescribeCloudMigrationResultQueries the details about a cloud migration task for an ApsaraDB RDS for PostgreSQL instance.

Tags

OperationDescription
TagResourcesCreates and adds tags to one or more ApsaraDB RDS instances.
UntagResourcesRemoves tags from one or more ApsaraDB RDS instances.
ListTagResourcesQueries the tags that are added to one or more ApsaraDB RDS instances.