This product(
Rds/2014-08-15) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (78410016550) and sign under the guidance of experts. Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.
Billing
| API | Title | Description |
|---|---|---|
| TransformDBInstancePayType | TransformDBInstancePayType | Changes the billing method of an ApsaraDB RDS instance. |
| ModifyDBInstancePayType | ModifyDBInstancePayType | Changes the billing method of an instance from pay-as-you-go to subscription. |
| ModifyInstanceAutoRenewalAttribute | ModifyInstanceAutoRenewalAttribute | Modifies the auto-renewal settings of an instance. |
| DescribePrice | DescribePrice | Queries the price of an instance. |
| DescribeRenewalPrice | DescribeRenewalPrice | Queries the renewal fees for a subscription instance. |
| DescribeInstanceAutoRenewalAttribute | DescribeInstanceAutoRenewalAttribute | Queries the automatic renewal status of an instance. |
| RenewInstance | RenewInstance | Manually renews an instance. |
Instance management
| API | Title | Description |
|---|---|---|
| CreateDBInstance | CreateDBInstance | Creates an instance. |
| CreateDBInstanceForRebuild | CreateDBInstanceForRebuild | Rebuilds an instance from the recycle bin. |
| DeleteDBInstance | DeleteDBInstance | Releases an instance. |
| RestartDBInstance | RestartDBInstance | Restarts an instance. |
| StopDBInstance | StopDBInstance | Suspends an ApsaraDB RDS instance. |
| StartDBInstance | StartDBInstance | Resumes an instance. |
| ModifyDBInstanceSpec | ModifyDBInstanceSpec | Changes the instance type and storage capacity of an ApsaraDB RDS instance. |
| ModifyDasInstanceConfig | ModifyDasInstanceConfig | Configures automatic storage expansion for an instance. |
| MigrateToOtherZone | MigrateToOtherZone | Migrates an instance across zones in the same region. |
| ModifyDBInstanceDescription | Modify the name of an instance | You can call the ModifyDBInstanceDescription operation to modify the name of an instance. |
| ModifyDBInstanceMaintainTime | ModifyDBInstanceMaintainTime | Modifies the maintenance window of an instance. |
| ModifyResourceGroup | ModifyResourceGroup | Moves an ApsaraDB RDS instance to a specified resource group. |
| ModifyHADiagnoseConfig | ModifyHADiagnoseConfig | Change the availability check method of an instance. |
| ModifyAccountSecurityPolicy | ModifyAccountSecurityPolicy | Modifies the password policy for an account of an ApsaraDB RDS for SQL Server instance. |
| DescribeSupportOnlineResizeDisk | DescribeSupportOnlineResizeDisk | Checks whether the disk of an ApsaraDB RDS for SQL Server instance can be resized online. |
| DescribeAvailableZones | DescribeAvailableZones | Queries the available zones for an instance. |
| DescribeAvailableClasses | DescribeAvailableClasses | Queries the specifications that are supported for an instance. The specifications include the instance type and the storage capacity. |
| DescribeDBInstanceAttribute | DescribeDBInstanceAttribute | Queries the details of an instance. |
| GetDBInstanceTopology | GetDBInstanceTopology | Queries the topology of an instance. |
| DescribeDBInstances | DescribeDBInstances | Queries instances. |
| ListClasses | ListClasses | Queries the specification details of an instance. |
| DescribeDBInstancesByExpireTime | DescribeDBInstancesByExpireTime | Queries the information about an ApsaraDB RDS instance based on the remaining subscription duration of an instance. |
| DescribeRegions | DescribeRegions | Queries the details of all regions and zones for ApsaraDB RDS. The regions that are no longer supported are also queried. Exercise caution when you call this operation. |
| CheckInstanceExist | Query whether an instance exists | You can call the CheckInstanceExist operation to query whether an ApsaraDB RDS instance exists. |
| DescribeHADiagnoseConfig | DescribeHADiagnoseConfig | Queries the availability check method of an instance. |
| CheckCloudResourceAuthorized | CheckCloudResourceAuthorized | Checks permissions that are granted on an instance. |
| ReleaseInstanceConnection | ReleaseInstanceConnection | Releases the public endpoint of an instance. |
Version upgrade
| API | Title | Description |
|---|---|---|
| ModifyDBInstanceAutoUpgradeMinorVersion | ModifyDBInstanceAutoUpgradeMinorVersion | Changes the method that is used to update the minor engine version of an ApsaraDB RDS for MySQL instance or an ApsaraDB RDS for PostgreSQL instance. |
| DescribeUpgradeMajorVersionPrecheckTask | DescribeUpgradeMajorVersionPrecheckTask | Queries the check report for a major engine version upgrade of an ApsaraDB RDS for MySQL instance or ApsaraDB RDS for PostgreSQL instance. |
| DescribeUpgradeMajorVersionTasks | DescribeUpgradeMajorVersionTasks | Queries the historical tasks for major engine version upgrades of an ApsaraDB RDS for PostgreSQL instance. |
| UpgradeDBInstanceEngineVersion | UpgradeDBInstanceEngineVersion | Upgrades the major engine version of an ApsaraDB RDS for MySQL instance. |
| UpgradeDBInstanceKernelVersion | UpgradeDBInstanceKernelVersion | Updates the minor engine version of an ApsaraDB RDS instance. |
| UpgradeDBInstanceMajorVersionPrecheck | UpgradeDBInstanceMajorVersionPrecheck | Performs a precheck before the upgrade of the major engine version of an ApsaraDB RDS for PostgreSQL instance. |
| UpgradeDBInstanceMajorVersion | UpgradeDBInstanceMajorVersion | Initiates a task to upgrade the major engine version of an ApsaraDB RDS for PostgreSQL instance. |
Network and Connection
| API | Title | Description |
|---|---|---|
| AllocateInstancePublicConnection | AllocateInstancePublicConnection | Apply for a public endpoint for an ApsaraDB RDS instance |
| ReleaseInstancePublicConnection | ReleaseInstancePublicConnection | Releases the public endpoint of an instance. |
| ModifyDBInstanceConnectionString | ModifyDBInstanceConnectionString | Modifies the endpoint and port of an instance. |
| ModifyDBInstanceNetworkExpireTime | ModifyDBInstanceNetworkExpireTime | Changes the expiration time of the classic network endpoint of an instance in hybrid access mode. |
| SwitchDBInstanceNetType | SwitchDBInstanceNetType | Switches between internal and public endpoints of an instance in the classic network. |
| ModifyDBInstanceNetworkType | ModifyDBInstanceNetworkType | Changes the network type of an ApsaraDB RDS instance from classic network to VPC |
| SwitchDBInstanceVpc | SwitchDBInstanceVpc | Changes the virtual private cloud (VPC) and vSwitch for an ApsaraDB RDS instance. |
| ModifyDBInstanceConfig | ModifyDBInstanceConfig | Modifies the configuration item of an instance. |
| DescribeDBInstanceNetInfo | DescribeDBInstanceNetInfo | Queries all endpoints of an instance. |
| DescribeVSwitches | DescribeVSwitches | Queries the details of vSwitch that are available in a virtual private cloud (VPC). |
Primary/Secondary High Availability and Data Replication
| API | Title | Description |
|---|---|---|
| ModifyDBInstanceHAConfig | ModifyDBInstanceHAConfig | Changes the high availability (HA) and data replication mode of an instance. |
| ModifyHASwitchConfig | ModifyHASwitchConfig | Enables or disables the automatic primary/secondary switchover feature for an instance. |
| DescribeDBInstanceHAConfig | DescribeDBInstanceHAConfig | Queries the high availability mode and data replication mode of an instance. |
| DescribeHASwitchConfig | DescribeHASwitchConfig | Queries the settings of the automatic primary/secondary switchover feature for an instance. |
| SwitchDBInstanceHA | SwitchDBInstanceHA | Switches workloads between primary and secondary ApsaraDB RDS instances. |
Event History
| API | Title | Description |
|---|---|---|
| ModifyActionEventPolicy | ModifyActionEventPolicy | Enables or disables the event history feature of an instance. |
| DescribeEvents | DescribeEvents | Queries historical events of an instance. |
| DescribeActionEventPolicy | DescribeActionEventPolicy | Queries whether the historical events feature is enabled. |
Notification
| API | Title | Description |
|---|---|---|
| QueryNotify | QueryNotify | Queries the notifications of an ApsaraDB RDS instance. |
| ConfirmNotify | ConfirmNotify | Marks the notifications of an instance within your Alibaba Cloud account as confirmed. |
Account management
| API | Title | Description |
|---|---|---|
| CreateAccount | CreateAccount | Creates a database account. |
| DeleteAccount | DeleteAccount | Deletes an account from an instance. |
| ModifyAccountCheckPolicy | ModifyAccountCheckPolicy | Checks whether a password policy is applied to an account. |
| ModifyAccountDescription | ModifyAccountDescription | Modifies the description of a database account. |
| ModifyPGHbaConfig | ModifyPGHbaConfig | Modifies the pg_hba.conf file of an ApsaraDB RDS for PostgreSQL instance. |
| DescribeAccounts | DescribeAccounts | Queries the details about the accounts that are created on an ApsaraDB RDS instance. |
| DescribeInstanceKeywords | DescribeInstanceKeywords | Queries the reserved keywords of an instance. The reserved keywords cannot be used for the usernames of accounts or the names of databases. |
| DescribePGHbaConfig | DescribePGHbaConfig | Queries the configuration of the pg_hba.conf file of an ApsaraDB RDS for PostgreSQL instance. |
| DescribeModifyPGHbaConfigLog | DescribeModifyPGHbaConfigLog | Queries the details about the modifications to the pg_hba.conf file of an ApsaraDB RDS for PostgreSQL instance. |
| ResetAccountPassword | ResetAccountPassword | Resets the password of a database account. |
| LockAccount | LockAccount | Locks an account of an ApsaraDB RDS for PostgreSQL instance. |
| UnlockAccount | UnlockAccount | Unlocks a database account of an ApsaraDB RDS for PostgreSQL instance. |
| GrantAccountPrivilege | GrantAccountPrivilege | Grants an account the permissions on a database of an instance. |
| GrantOperatorPermission | GrantOperatorPermission | Grant permissions to a service account. |
| RevokeOperatorPermission | RevokeOperatorPermission | Revokes permissions from the service account of an ApsaraDB RDS instance. |
| RevokeAccountPrivilege | RevokeAccountPrivilege | Removes the permissions on a database of an ApsaraDB RDS instance from an account. |
| ResetAccount | ResetAccount | Resets the permissions of the privileged account. |
| CheckAccountNameAvailable | CheckAccountNameAvailable | Checks whether the username of the account that you want to create on an instance is available. |
Database management
| API | Title | Description |
|---|---|---|
| CreateDatabase | CreateDatabase | Creates a database in an ApsaraDB RDS instance. |
| DeleteDatabase | DeleteDatabase | Deletes a database from an RDS instance. |
| ModifyDBDescription | ModifyDBDescription | Modifies the description of an instance. |
| ModifyDatabaseConfig | ModifyDatabaseConfig | Modifies the property settings of an ApsaraDB RDS for SQL Server instance. |
| ModifyCollationTimeZone | ModifyCollationTimeZone | Modifies the character set collation and time zone of system databases on an instance. |
| DescribeDatabases | DescribeDatabases | Queries the details about the databases on an instance. |
| DescribeCollationTimeZones | DescribeCollationTimeZones | Queries the character set collations and time zones that are available for use in ApsaraDB RDS for SQL Server. |
| DescribeCharacterSetName | DescribeCharacterSetName | Queries the character sets that are supported by an instance. |
| CopyDatabaseBetweenInstances | CopyDatabaseBetweenInstances | Replicates databases between RDS SQL Server instances. |
| CheckDBNameAvailable | CheckDBNameAvailable | Checks whether a database name is unique and conforms to the naming conventions on an instance. |
Read-Only Instances
| API | Title | Description |
|---|---|---|
| CreateReadOnlyDBInstance | CreateReadOnlyDBInstance | Creates a read-only instance. |
| ModifyReadonlyInstanceDelayReplicationTime | ModifyReadonlyInstanceDelayReplicationTime | Modifies the latency at which a read-only ApsaraDB RDS for MySQL instance replicates data from its primary instance. |
| DescribeReadDBInstanceDelay | DescribeReadDBInstanceDelay | Queries the latency of data replication between a primary instance and its read-only instance. |
RDS Cluster Edition
| API | Title | Description |
|---|---|---|
| CreateDBNodes | CreateDBNodes | Adds a node to an ApsaraDB RDS for MySQL or ApsaraDB RDS for PostgreSQL instance that runs RDS Cluster Edition. An RDS instance that runs RDS Cluster Edition is referred to as an RDS cluster. |
| CreateDBInstanceEndpoint | CreateDBInstanceEndpoint | Creates an endpoint for an instance that runs RDS Cluster Edition. |
| CreateDBInstanceEndpointAddress | CreateDBInstanceEndpointAddress | Creates a public endpoint for an instance that runs RDS Cluster Edition. |
| DeleteDBNodes | DeleteDBNodes | Deletes a node from an instance that runs RDS Cluster Edition. |
| DeleteDBInstanceEndpoint | DeleteDBInstanceEndpoint | Deletes an endpoint for an instance that runs RDS Cluster Edition. |
| DeleteDBInstanceEndpointAddress | DeleteDBInstanceEndpointAddress | Releases the public endpoint of an instance that runs RDS Cluster Edition. |
| ModifyDBInstanceEndpoint | ModifyDBInstanceEndpoint | Modifies the weight of an endpoint for an instance that runs RDS Cluster Edition. |
| ModifyDBInstanceEndpointAddress | ModifyDBInstanceEndpointAddress | Modifies the information about the endpoint of an instance that runs RDS Cluster Edition. |
| DescribeDBInstanceEndpoints | DescribeDBInstanceEndpoints | Queries the information about the endpoints of an instance that runs RDS Cluster Edition. |
Dedicated proxy
| API | Title | Description |
|---|---|---|
| CreateDBProxyEndpointAddress | CreateDBProxyEndpointAddress | Creates the endpoint that is used to connect to the dedicated proxy of an instance. |
| DeleteDBProxyEndpointAddress | DeleteDBProxyEndpointAddress | Deletes the endpoint that is used to connect to the dedicated proxy of an instance. |
| ModifyDBProxy | ModifyDBProxy | Enables or modifies the database proxy feature for an instance. |
| UpgradeDBProxyInstanceKernelVersion | UpgradeDBProxyInstanceKernelVersion | Upgrades the database proxy version of an instance. |
| ModifyDBProxyInstance | ModifyDBProxyInstance | Changes the configuration of a database proxy for an instance. |
| ModifyDBProxyEndpoint | ModifyDBProxyEndpoint | Modifies the connection settings for a database proxy endpoint. |
| ModifyDBProxyEndpointAddress | ModifyDBProxyEndpointAddress | Modifies the database proxy endpoint of an instance. |
| ModifyDbProxyInstanceSsl | ModifyDbProxyInstanceSsl | Configures SSL encryption for an dedicated proxy endpoint of an ApsaraDB RDS for MySQL instance. |
| DescribeDBProxy | DescribeDBProxy | Queries the settings of the database proxy feature for an instance. |
| DescribeDBProxyEndpoint | DescribeDBProxyEndpoint | Queries the information about the database proxy endpoints of an instance. |
| DescribeDBProxyPerformance | DescribeDBProxyPerformance | Queries the performance data of the database proxy for an instance. |
| GetDbProxyInstanceSsl | GetDbProxyInstanceSsl | Queries the SSL encryption settings for a dedicated proxy endpoint of an ApsaraDB RDS for MySQL instance. |
Shared proxy (phased-out)
| API | Title | Description |
|---|---|---|
| ModifyReadWriteSplittingConnection | ModifyReadWriteSplittingConnection | Modifies the latency threshold of the read/write splitting link and the read weights of a primary instance and its read-only instances. |
| DescribeDBInstanceProxyConfiguration | DescribeDBInstanceProxyConfiguration | Queries the settings of shared proxies that are enabled on an instance. |
| AllocateReadWriteSplittingConnection | AllocateReadWriteSplittingConnection | Applies for a read-only routing endpoint for an instance. |
| ReleaseReadWriteSplittingConnection | ReleaseReadWriteSplittingConnection | Releases the read/write splitting endpoint of an instance. |
| CalculateDBInstanceWeight | CalculateDBInstanceWeight | Queries system-assigned read weights. |
Security management
| API | Title | Description |
|---|---|---|
| AttachWhitelistTemplateToInstance | AttachWhitelistTemplateToInstance | Associates a whitelist template with an instance. |
| CreateServiceLinkedRole | CreateServiceLinkedRole | Creates a service-linked role. |
| DetachWhitelistTemplateToInstance | DetachWhitelistTemplateToInstance | Disassociates a whitelist template from an instance. |
| ModifyWhitelistTemplate | ModifyWhitelistTemplate | Edits a whitelist. You can call this operation to create, modify, or delete a whitelist. |
| DescribeSecurityGroupConfiguration | DescribeSecurityGroupConfiguration | Queries ECS security groups to which an instance is added. |
| ModifySecurityGroupConfiguration | ModifySecurityGroupConfiguration | Changes the ECS security groups to which an instance is added. |
| CreateDBInstanceSecurityGroupRule | CreateDBInstanceSecurityGroupRule | Adds a security group rule to an ApsaraDB RDS for SQL Server instance. |
| DescribeDBInstanceSecurityGroupRule | DescribeDBInstanceSecurityGroupRule | Queries the security group rules that are configured for an ApsaraDB RDS for SQL Server instance. |
| ModifyDBInstanceSecurityGroupRule | ModifyDBInstanceSecurityGroupRule | Modifies a security group rule that is configured for an ApsaraDB RDS for SQL Server instance. |
| DeleteDBInstanceSecurityGroupRule | DeleteDBInstanceSecurityGroupRule | Deletes a security group rule that is configured for an ApsaraDB RDS for SQL Server instance. |
| ModifySecurityIps | ModifySecurityIps | Modifies the IP address whitelist of an ApsaraDB RDS instance. |
| ModifyDBInstanceSSL | ModifyDBInstanceSSL | Modifies the SSL encryption settings of an instance. |
| ModifyDBInstanceTDE | ModifyDBInstanceTDE | Enables the Transparent Data Encryption (TDE) feature for an ApsaraDB RDS instance and modifies the TDE status for the instance. |
| ModifyDTCSecurityIpHostsForSQLServer | ModifyDTCSecurityIpHostsForSQLServer | Configures a distributed transaction whitelist for an ApsaraDB RDS for SQL Server instance. |
| ModifyDBInstanceDeletionProtection | ModifyDBInstanceDeletionProtection | Enable or disable the release protection feature for an instance. |
| DescribeWhitelistTemplateLinkedInstance | DescribeWhitelistTemplateLinkedInstance | Queries associated instances by whitelist template. |
| DescribeInstanceLinkedWhitelistTemplate | DescribeInstanceLinkedWhitelistTemplate | Queries associated whitelists by instance name. |
| DescribeWhitelistTemplate | DescribeWhitelistTemplate | Queries information about the specified IP whitelist. |
| DescribeAllWhitelistTemplate | DescribeAllWhitelistTemplate | Queries whitelist templates at a time by using fuzzy search. |
| DescribeDBInstanceIPArrayList | DescribeDBInstanceIPArrayList | Queries the IP address whitelist of an ApsaraDB RDS instance. |
| DescribeDBInstanceSSL | DescribeDBInstanceSSL | Queries the SSL configurations of an instance. |
| DescribeDBInstanceTDE | DescribeDBInstanceTDE | Queries the status of the Transparent Data Encryption (TDE) feature for an instance. |
| DescribeDBInstanceEncryptionKey | DescribeDBInstanceEncryptionKey | You can call the DescribeDBInstanceEncryptionKey operation to check whether disk encryption is enabled for an instance. You can also query details about the keys that are used for disk encryption. This operation is supported for instances that run MySQL, SQL Server, or PostgreSQL. |
| DescribeDBInstanceIpHostname | DescribeDBInstanceIpHostname | Queries the internal IP address and hostname of the Elastic Compute Service (ECS) instance on which the ApsaraDB RDS for SQL Server instance runs. |
| DescribeDTCSecurityIpHostsForSQLServer | DescribeDTCSecurityIpHostsForSQLServer | Queries the distributed transaction whitelists of an ApsaraDB RDS for SQL Server instance. |
| MigrateSecurityIPMode | MigrateSecurityIPMode | Changes the whitelist mode of an instance from the standard whitelist mode to the enhanced whitelist mode. |
Log management
| API | Title | Description |
|---|---|---|
| ModifySQLCollectorPolicy | ModifySQLCollectorPolicy | Enables or disables the SQL Explorer (SQL Audit) feature for an instance. |
| ModifySQLCollectorRetention | ModifySQLCollectorRetention | Changes the retention period of the log files that are generated by the SQL Explorer feature for an ApsaraDB RDS instance. |
| DescribeSQLCollectorPolicy | DescribeSQLCollectorPolicy | Queries the status of the SQL Explorer (SQL Audit) feature for an ApsaraDB RDS instance. |
| DescribeSQLLogRecords | DescribeSQLLogRecords | Queries the logs that are generated by the SQL Explorer (SQL Audit) feature for an instance. |
| DescribeSQLLogFiles | DescribeSQLLogFiles | Queries the log files that are generated by the SQL Explorer (SQL Audit) feature for an instance. The DescribeSQLLogFiles operation does not return the log files that are generated by the SQL Explorer feature and manually exported from the ApsaraDB RDS console. The DescribeSQLLogFiles operation returns the SQL Explorer log files that are generated by calling the DescribeSQLLogRecords operation with the request parameter Form set to File. |
| DescribeSQLCollectorRetention | DescribeSQLCollectorRetention | Queries the retention period of the log files that are generated by the SQL Explorer feature for an instance. |
| DescribeSlowLogs | DescribeSlowLogs | Queries the statistics on slow query logs. |
| DescribeSlowLogRecords | DescribeSlowLogRecords | Queries the slow log details of an instance. |
| DescribeErrorLogs | DescribeErrorLogs | Queries the error logs of an instance over a specific time range. |
| DescribeSQLLogReportList | DescribeSQLLogReportList | Queries SQL log reports. |
| PurgeDBInstanceLog | PurgeDBInstanceLog | Clears the on-premises logs of an ApsaraDB RDS instance. |
Backup and recovery
| API | Title | Description |
|---|---|---|
| CreateBackup | CreateBackup | Creates a backup file for an instance. |
| DeleteBackup | DeleteBackup | Deletes the data backup files of an ApsaraDB RDS instance. |
| DeleteBackupFile | DeleteBackupFile | Deletes the backup files of an ApsaraDB RDS for SQL Server instance. |
| ModifyBackupPolicy | ModifyBackupPolicy | Modifies the backup policy settings of an instance. |
| DescribeBackups | DescribeBackups | Queries the data backup files of an ApsaraDB RDS instance. |
| DescribeDetachedBackups | DescribeDetachedBackups | Queries the data backup files of an ApsaraDB RDS instance that is released. |
| DescribeBackupPolicy | DescribeBackupPolicy | Queries the backup settings of an instance. |
| DescribeBackupTasks | DescribeBackupTasks | Queries the backup tasks of an instance. |
| DescribeBinlogFiles | DescribeBinlogFiles | Queries the binary log files of an instance that runs MySQL or MariaDB or the write-ahead logging (WAL) files of an instance that runs PostgreSQL. |
| DescribeLogBackupFiles | DescribeLogBackupFiles | Queries the log backup files of an ApsaraDB RDS for SQL Server instance. |
Restoration
| API | Title | Description |
|---|---|---|
| CreateTempDBInstance | CreateTempDBInstance | Creates a temporary instance for an RDS instance that runs SQL Server 2008 R2 and uses local disks. |
| DescribeLocalAvailableRecoveryTime | DescribeLocalAvailableRecoveryTime | Queries the time range to which an RDS instance can be restored. |
| DescribeMetaList | DescribeMetaList | Queries the information about the databases and tables that can be restored from a specified backup set. |
| RecoveryDBInstance | RecoveryDBInstance | Restores backup data of an ApsaraDB RDS for SQL Server instance to an existing instance or a new instance. |
| CloneDBInstance | CloneDBInstance | Restores the data of an original instance to a new instance. The new instance is called a cloned instance. |
| RestoreTable | RestoreTable | Restores individual databases or tables of an instance to the original instance. |
Cross-region backup and restoration
| API | Title | Description |
|---|---|---|
| CreateDdrInstance | CreateDdrInstance | Restores data to a new instance across regions. |
| ModifyInstanceCrossBackupPolicy | ModifyInstanceCrossBackupPolicy | Modifies the cross-region backup settings of an instance. |
| DescribeInstanceCrossBackupPolicy | DescribeInstanceCrossBackupPolicy | Queries the cross-region backup settings of an instance. |
| DescribeCrossBackupMetaList | DescribeCrossBackupMetaList | Queries the databases and tables whose data is included in a cross-region backup file of an instance. |
| DescribeCrossRegionBackups | DescribeCrossRegionBackups | Queries the cross-region data backup files of an instance. |
| DescribeCrossRegionLogBackupFiles | DescribeCrossRegionLogBackupFiles | Queries the cross-region log backup files of an instance. |
| DescribeAvailableCrossRegion | DescribeAvailableCrossRegion | Queries the available destination regions to which the cross-region backup files from a specific source region can be replicated. |
| DescribeAvailableRecoveryTime | DescribeAvailableRecoveryTime | Queries the time range within which data can be restored from a cross-region backup file. |
| DescribeCrossRegionBackupDBInstance | DescribeCrossRegionBackupDBInstance | Queries the instances for which the cross-region backup feature is enabled in a region and the cross-region backup settings of these instances. |
| CheckCreateDdrDBInstance | CheckCreateDdrDBInstance | Queries whether an instance can be restored by using a cross-region backup set. |
| RestoreDdrTable | RestoreDdrTable | Restores data to an existing instance across regions. |
Monitoring management
| API | Title | Description |
|---|---|---|
| ModifyDBInstanceMonitor | ModifyDBInstanceMonitor | Modifies a monitoring frequency. |
| ModifyDBInstanceMetrics | ModifyDBInstanceMetrics | Modifies the Enhanced Monitoring metrics that are displayed for an ApsaraDB RDS for PostgreSQL instance. |
| DescribeResourceUsage | DescribeResourceUsage | Queries the storage usage of an instance. |
| DescribeDBInstancePerformance | DescribeDBInstancePerformance | Queries the performance metrics of an instance. |
| DescribeDBInstanceMonitor | DescribeDBInstanceMonitor | Queries the monitoring frequency of an instance. |
| DescribeAvailableMetrics | DescribeAvailableMetrics | Queries all Enhanced Monitoring metrics that are supported by an ApsaraDB RDS for PostgreSQL instance. |
| DescribeDBInstanceMetrics | DescribeDBInstanceMetrics | Queries the Enhanced Monitoring metrics that are displayed for an ApsaraDB RDS for PostgreSQL instance. |
Parameter management
| API | Title | Description |
|---|---|---|
| CreateParameterGroup | CreateParameterGroup | Creates a parameter template for an instance. |
| DeleteParameterGroup | DeleteParameterGroup | Deletes a parameter template from an instance. |
| ModifyParameter | ModifyParameter | Modifies the parameter values of an instance. |
| ModifyParameterGroup | ModifyParameterGroup | Modifies the parameter template of an instance. |
| DescribeParameters | DescribeParameters | Queries the parameter settings of an instance. |
| DescribeModifyParameterLog | DescribeModifyParameterLog | Queries the parameter modification logs of an instance. |
| DescribeParameterTemplates | DescribeParameterTemplates | Queries parameter templates. |
| DescribeParameterGroups | DescribeParameterGroups | Queries the parameter templates that are available in a region. |
| DescribeParameterGroup | DescribeParameterGroup | Queries the information about a parameter template. |
| CloneParameterGroup | CloneParameterGroup | Replicates a parameter template to the current region or another region. |
Data migration
| API | Title | Description |
|---|---|---|
| DescibeImportsFromDatabase | DescibeImportsFromDatabase | Queries the migration tasks of an instance. |
Operation tasks
| API | Title | Description |
|---|---|---|
| ModifyActiveOperationTasks | ModifyActiveOperationTasks | Changes the switching time of scheduled O\\\\\\&M tasks for an instance. |
| DescribeActiveOperationTasks | DescribeActiveOperationTasks | Queries the details about scheduled O\\\\\\\\\\&M tasks for an instance. |
| CancelActiveOperationTasks | CancelActiveOperationTasks | Cancels O\\\&M tasks that are not started. |
Migrate MySQL to the cloud
| API | Title | Description |
|---|---|---|
| DeleteUserBackupFile | DeleteUserBackupFile | Deletes the backup files of an ApsaraDB RDS for MySQL instance. |
| UpdateUserBackupFile | UpdateUserBackupFile | Modifies the description and retention period of a full backup file. |
| ListUserBackupFiles | ListUserBackupFiles | Queries the details about the full backup files that are imported into an instance. |
| ImportUserBackupFile | ImportUserBackupFile | Imports the backup data of a self-managed instance that runs MySQL 5.7 to an ApsaraDB RDS for MySQL instance. |
Migrate SQL Server to the cloud
| API | Title | Description |
|---|---|---|
| CreateMigrateTask | CreateMigrateTask | Creates a migration task to restore backup files from an Object Storage Service (OSS) bucket to an ApsaraDB RDS for SQL Server instance. |
| CreateOnlineDatabaseTask | CreateOnlineDatabaseTask | Opens the database that is involved in a backup data migration task of an ApsaraDB RDS for SQL Server instance. |
| DescribeMigrateTasks | DescribeMigrateTasks | Queries the tasks that are created to migrate the backup data of an ApsaraDB RDS for SQL Server instance. |
| DescribeOssDownloads | DescribeOssDownloads | Queries the backup files that are included in a backup data migration task of an ApsaraDB RDS for SQL Server instance. |
| DescribeMigrateTaskById | DescribeMigrateTaskById | Queries a task that is used to import the backup data of an ApsaraDB RDS for SQL Server instance to an Object Storage Service (OSS) bucket. |
| TerminateMigrateTask | TerminateMigrateTask | Terminates an ongoing migration task of an ApsaraDB RDS for SQL Server instance. |
SQL Server Active Directory (AD) domain
| API | Title | Description |
|---|---|---|
| DeleteADSetting | DeleteADSetting | Deletes an ApsaraDB RDS for SQL Server instance from an Active Directory (AD) domain. |
| ModifyADInfo | ModifyADInfo | Modifies the AD domain information about an ApsaraDB RDS for SQL Server instance. |
| DescribeADInfo | DescribeADInfo | Queries information about the AD domain of an instance. The information includes whether the instance is added to the AD domain, the name of the AD domain, and the account. |
Cloud migration to an ApsaraDB RDS for PostgreSQL instance
| API | Title | Description |
|---|---|---|
| CreateCloudMigrationPrecheckTask | CreateCloudMigrationPrecheckTask | Creates an assessment task for cloud migration to an ApsaraDB RDS for PostgreSQL instance. |
| CreateCloudMigrationTask | CreateCloudMigrationTask | Creates a cloud migration task for an ApsaraDB RDS for PostgreSQL instance. |
| DescribeCloudMigrationPrecheckResult | DescribeCloudMigrationPrecheckResult | Query the details about the assessment report for cloud migration to an instance. |
| DescribeCloudMigrationResult | DescribeCloudMigrationResult | Queries the details about the cloud migration task of an ApsaraDB RDS for PostgreSQL instance. |
| ActivateMigrationTargetInstance | ActivateMigrationTargetInstance | Switches workloads over from the source PostgreSQL instance to the destination ApsaraDB RDS for PostgreSQL instance. |
Tag management
| API | Title | Description |
|---|---|---|
| TagResources | TagResources | Creates and adds tags to one or more instances. |
| AddTagsToResource | AddTagsToResource | Adds tags to an instance. |
| UntagResources | UntagResources | Removes tags from one or more instances. |
| RemoveTagsFromResource | RemoveTagsFromResource | Removes tags from an instance. |
| ListTagResources | ListTagResources | Queries the tags that are added to one or more instances. |
| DescribeTags | DescribeTags | Queries tags of an instance. |
| DescribeDBInstanceByTags | DescribeDBInstanceByTags | Queries information about the tags that are added to an instance. |
Extensions management
| API | Title | Description |
|---|---|---|
| CreatePostgresExtensions | CreatePostgresExtensions | Creates an extension for a database. |
| DeletePostgresExtensions | DeletePostgresExtensions | Deletes an extension from a database. |
| UpdatePostgresExtensions | UpdatePostgresExtensions | Updates the version of an extension on a database. |
| DescribePostgresExtensions | DescribePostgresExtensions | Queries extensions that are installed on a database. |
Manager Replication Solt on ApsaraDB RDS for PostgreSQL instance
| API | Title | Description |
|---|---|---|
| DeleteSlot | DeleteSlot | Deletes a replication slot of an instance. |
| DescribeSlots | DescribeSlots | Queries all replication slots of an instance. |
Other APIs
| API | Title | Description |
|---|---|---|
| User secrets | User secrets | |
| CreateSecret | CreateSecret | Creates a credential for a user who uses the Data API feature. |
| DeleteSecret | DeleteSecret | Deletes the credential of a user who uses the Data API feature. |
| DescribeSecrets | DescribeSecrets | Queries the credential of a user who uses the Data API feature. |
| Dedicated cluster management | Dedicated cluster management | |
| DescribeDedicatedHostGroups | DescribeDedicatedHostGroups | Queries information about an ApsaraDB MyBase dedicated cluster. |
| DescribeDedicatedHosts | DescribeDedicatedHosts | Queries the information about the hosts in a dedicated cluster. |
| MigrateDBInstance | MigrateDBInstance | Migrates an instance across hosts in a dedicated cluster. |
| RebuildDBInstance | RebuildDBInstance | Rebuilds the secondary instance of a primary instance in a dedicated cluster. |
| MigrateConnectionToOtherZone | MigrateConnectionToOtherZone | Migrates an instance to a different zone. |
| ModifyDBInstanceDelayedReplicationTime | ModifyDBInstanceDelayedReplicationTime | Configures the replication latency for a read-only ApsaraDB RDS for MySQL instance. |
| CheckServiceLinkedRole | CheckServiceLinkedRole | Checks whether a service-linked role (SLR) is created. |
| DescribeDBMiniEngineVersions | DescribeDBMiniEngineVersions | Queries minor engine versions that are available for an ApsaraDB RDS for MySQL instance or an ApsaraDB RDS for PostgreSQL instance. |
| DescribeRegionInfos | DescribeRegionInfos | Queries the regions. |
| DescribeDBInstanceNetInfoForChannel | DescribeDBInstanceNetInfoForChannel | Queries all endpoints of an instance. |
| DescribeHostWebShell | DescribeHostWebShell | Queries the webshell URL that is used to connect to the host of an ApsaraDB RDS for SQL Server instance. |
| DescribeClassDetails | DescribeClassDetails | Queries the details about the instance types of an instance by using the code of the instance types. |
| DescribeKmsAssociateResources | DescribeKmsAssociateResources | Checks whether the specified resource of Key Management Service (KMS) is associated with an ApsaraDB RDS instance. |
| DeleteReplicationLink | DeleteReplicationLink | Deletes the data synchronization link of a disaster recovery RDS instance and promotes the disaster recovery instance to the primary instance. |
| DescribeReplicationLinkLogs | DescribeReplicationLinkLogs | Queries the operation logs of the data synchronization task for a specified ApsaraDB RDS instance. |
| CreateReplicationLink | CreateReplicationLink | Creates a disaster recovery instance for an ApsaraDB RDS instance and configures a data synchronization link. |
| RebuildReplicationLink | RebuildReplicationLink | Re-creates a data synchronization link for a disaster recovery ApsaraDB RDS instance. |
Events and Tasks
| API | Title | Description |
|---|---|---|
| DescribeHistoryEventsStat | DescribeHistoryEventsStat | Queries the statistics of historical events in the event center. |
| DescribeHistoryEvents | DescribeHistoryEvents | Queries historical events in the event center. |
| ModifyEventInfo | ModifyEventInfo | Modifies information about the events in the event center. |
| DescribeHistoryTasksStat | DescribeHistoryTasksStat | Collects tasks in the task center. |
| DescribeHistoryTasks | DescribeHistoryTasks | Queries the historical tasks that are created within 30 days. |
| ModifyTaskInfo | ModifyTaskInfo | Modifies information about the historical tasks in the task center. |
Obsolete APIs
| API | Title | Description |
|---|---|---|
| Diagnostics | Diagnostics | |
| DescribeDiagnosticReportList | DescribeDiagnosticReportList | Queries the information about diagnostics reports. |
| DestroyDBInstance | DestroyDBInstance | You can call the DestroyDBInstance operation to destroy an instance. The instance is in the Locked state. |
| DescribeTasks | DescribeTasks | You can call the DescribeTasks operation to query the tasks that are running on an instance. |
| DescribeDBInstancesForClone | DescribeDBInstancesForClone | Queries a list of instances. |
| DescribeDBInstancesByPerformance | Query instances base on performance | You can call the DescribeDBInstancePerformance operation to query the performance of instances. |
| DescribeDBInstanceDetail | Query the details of an instance | You can call the DescribeDBInstanceDetail operation to query the details of an instance. |
| DescribeDBInstancesAsCsv | DescribeDBInstancesAsCsv | Queries the instances. |
| ReceiveDBInstance | ReceiveDBInstance | Switches a primary instance to a disaster recovery instance or a disaster recovery instance to a primary instance. |
| DescribeDBInstancePromoteActivity | DescribeDBInstancePromoteActivity | The operation is phased out. |
| DescribeBackupDatabase | DescribeBackupDatabase | Queries the databases that are involved in a backup file. |
| CopyDatabase | CopyDatabase | Replicates the databases of an instance that runs SQL Server 2008 R2 to another instance. This operation is phased out. |