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 (11370001915) 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 |
|---|---|---|
| DescribePrice | Query the price of an instance | You can call the DescribePrice operation to query the price of an instance. |
| DescribeRenewalPrice | Query the renewal fee for an instance | You can call the DescribeRenewalPrice operation to query the renewal fee for an instance. |
| TransformDBInstancePayType | TransformDBInstancePayType | Changes the billing method of an instance. |
| RenewInstance | Manually renew an ApsaraDB RDS instance | You can call the RenewInstance operation to manually renew an ApsaraDB RDS instance. |
| ModifyDBInstancePayType | ModifyDBInstancePayType | Changes the billing method of an instance from pay-as-you-go to subscription. |
| ModifyInstanceAutoRenewalAttribute | Modify auto-renewal settings | You can call the ModifyInstanceAutoRenewalAttribute operation to modify the auto-renewal settings of an ApsaraDB for RDS instance. |
| DescribeInstanceAutoRenewalAttribute | Query the automatic renewal status of an RDS instance | Query the automatic renewal status of an RDS instance. |
Instance management
| API | Title | Description |
|---|---|---|
| CreateDBInstance | CreateDBInstance | Creates an instance. |
| DeleteDBInstance | DeleteDBInstance | Releases an instance. |
| CreateDBInstanceForRebuild | CreateDBInstanceForRebuild | Rebuilds an instance from the recycle bin. |
| RestartDBInstance | RestartDBInstance | Restarts an instance. |
| StartDBInstance | StartDBInstance | Starts an instance in a dedicated cluster. |
| DescribeSupportOnlineResizeDisk | DescribeSupportOnlineResizeDisk | Checks whether the disk of an instance can be resized online. |
| ModifyDBInstanceSpec | ModifyDBInstanceSpec | Changes the instance type or storage capacity of an instance. This operation is supported for regular instances and read-only instances. This operation is not supported for disaster recovery instances or temporary instances. |
| ModifyDasInstanceConfig | Configure automatic storage expansion | You can call the ModifyDasInstanceConfig operation to configure automatic storage expansion for an ApsaraDB RDS instance. |
| DescribeAvailableZones | DescribeAvailableZones | Queries the available resources in the zone in which an instance resides. |
| DescribeAvailableClasses | DescribeAvailableClasses | Queries the specifications that are supported for an instance. The specifications include the instance type and the storage capacity. |
| DescribeDBInstanceAttribute | Query instance details | You can call the DescribeDBInstanceAttribute operation to query the details about one or more instances. |
| GetDBInstanceTopology | GetDBInstanceTopology | Queries the topology of an instance. |
| DescribeDBInstances | DescribeDBInstances | Queries a list of instances. |
| ListClasses | ListClasses | Queries the details about the available instance types. |
| DescribeDBInstancesByExpireTime | Query instances based on a specific expiration date and time | You can call the DescribeDBInstancesByExpireTime operation to query instances based on a specific expiration date and time. |
| MigrateToOtherZone | MigrateToOtherZone | Migrates an instance across zones. |
| ModifyHADiagnoseConfig | Change the availability check method of an instance | You can call the ModifyHADiagnoseConfig operation to change the availability check method of an instance. |
| DescribeAnalyticdbByPrimaryDBInstance | Query the number of analytic instances that are associated with an ApsaraDB RDS for MySQL instance | You can call the DescribeAnalyticdbByPrimaryDBInstance operation to query the number of analytic instances that are associated with an ApsaraDB RDS for MySQL instance. |
| CheckCloudResourceAuthorized | Check cloud resource permissions | You can call the CheckCloudResourceAuthorized operation to check permissions that are granted on cloud resources. |
| DescribeDBInstancesAsCsv | Query information about an instance | You can call the DescribeDBInstancesAsCsv operation to query information about an instance. |
| DescribeRdsResourceSettings | DescribeRdsResourceSettings | This operation is deprecated. |
Version upgrade
| API | Title | Description |
|---|---|---|
| UpgradeDBInstanceEngineVersion | UpgradeDBInstanceEngineVersion | Upgrades the database engine version of an instance. |
| UpgradeDBInstanceKernelVersion | UpgradeDBInstanceKernelVersion | Updates the minor engine version of an instance. |
| ModifyDBInstanceAutoUpgradeMinorVersion | ModifyDBInstanceAutoUpgradeMinorVersion | Changes the method that is used to update the minor engine version of an instance. |
| UpgradeDBInstanceMajorVersionPrecheck | UpgradeDBInstanceMajorVersionPrecheck | check the compatibility between a new major engine version and an ApsaraDB RDS for PostgreSQL instance before you upgrade the instance to the new major engine version. |
| DescribeUpgradeMajorVersionPrecheckTask | Query the check report for a major engine version upgrade to an ApsaraDB RDS for PostgreSQL instance | You can call the DescribeUpgradeMajorVersionPrecheckTask operation to query the check report for a major engine version upgrade to an ApsaraDB RDS for PostgreSQL instance. |
| UpgradeDBInstanceMajorVersion | UpgradeDBInstanceMajorVersion | Queries the tasks that are created to upgrade the major engine version of an ApsaraDB RDS for PostgreSQL instance. |
| DescribeUpgradeMajorVersionTasks | Query the tasks for major engine version upgrades | You can call the DescribeUpgradeMajorVersionTasks operation to query the tasks that are created to upgrade the major engine version of an ApsaraDB RDS for PostgreSQL instance. |
Network and Connection
| API | Title | Description |
|---|---|---|
| AllocateInstancePublicConnection | AllocateInstancePublicConnection | Assigns a public endpoint to an instance. |
| DescribeDBInstanceNetInfo | DescribeDBInstanceNetInfo | Queries the endpoints of an instance. |
| ModifyDBInstanceConnectionString | ModifyDBInstanceConnectionString | Changes the endpoint and port of an instance. |
| SwitchDBInstanceNetType | Switch between internal and public endpoints | You can call the SwitchDBInstanceNetType operation to switch an ApsaraDB RDS instance between its internal and public endpoints. |
| ModifyDBInstanceNetworkType | ModifyDBInstanceNetworkType | Changes the network type of an instance. |
| SwitchDBInstanceVpc | SwitchDBInstanceVpc | Changes the virtual private cloud (VPC) or vSwitch of an instance. |
| DescribeVSwitches | DescribeVSwitches | Queries the information about a vSwitch that is created 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. |
| DescribeDBInstanceHAConfig | DescribeDBInstanceHAConfig | Queries the high availability mode and data replication mode of an instance. |
| ModifyHASwitchConfig | Enable or disable the automatic primary/secondary switchover feature | You can call the ModifyHASwitchConfig operation to enable or disable the automatic primary/secondary switchover feature for an ApsaraDB RDS instance. |
| DescribeHASwitchConfig | Queries the status of the automatic primary/secondary switchover function | Queries the status of the automatic primary/secondary switchover function for an ApsaraDB for RDS instance. |
Event History
| API | Title | Description |
|---|---|---|
| DescribeEvents | Query historical events | You can call the DescribeEvents operation to query the historical events of an ApsaraDB RDS instance. |
| ModifyActionEventPolicy | Enable or disable the event history feature | Enables or disables the event history feature of an ApsaraDB for RDS instance. |
Notification
| API | Title | Description |
|---|---|---|
| QueryNotify | Query notifications for an ApsaraDB RDS instance | You can call the QueryNotify operation to query notifications for an ApsaraDB RDS instance. |
| ConfirmNotify | Mark notification confirmed | You can call the ConfirmNotify operation to mark the notifications of an ApsaraDB RDS instance as confirmed. |
Account management
| API | Title | Description |
|---|---|---|
| CreateAccount | CreateAccount | Creates an account to manage databases on an instance. |
| DeleteAccount | DeleteAccount | Deletes an account from an instance. |
| ResetAccountPassword | ResetAccountPassword | You can call the ResetAccountPassword operation to reset the password of an account on an instance. |
| DescribeAccounts | DescribeAccounts | Queries the details of accounts that are created on an instance. |
| ModifyAccountDescription | ModifyAccountDescription | You can call the ModifyAccountDescription operation to modify the description of an account of an instance. |
| DescribeInstanceKeywords | Query reserved keywords | You can call the DescribeInstanceKeywords operation to query 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 | ModifyPGHbaConfig | Modifies the pg_hba.conf file of an ApsaraDB RDS for PostgreSQL instance. |
| DescribePGHbaConfig | Query the configuration of the pg_hba.conf file of an ApsaraDB RDS for PostgreSQL instance | You can call the DescribePGHbaConfig operation to query the configuration of the pg_hba.conf file of an ApsaraDB RDS for PostgreSQL instance. |
| DescribeModifyPGHbaConfigLog | Query the modification history of the pg_hba.conf file of an ApsaraDB RDS for PostgreSQL instance | You can call the DescribeModifyPGHbaConfigLog operation to query the modification history of the pg_hba.conf file of an ApsaraDB RDS for PostgreSQL instance. |
| GrantAccountPrivilege | GrantAccountPrivilege | Grants an account the permissions on a database of an instance. |
| RevokeAccountPrivilege | RevokeAccountPrivilege | Revokes database access permissions of an account. |
| ResetAccount | ResetAccount | Resets the permissions of the privileged account. |
| CheckAccountNameAvailable | Check account name's availability | You can call the CheckAccountNameAvailable operation to check whether the name of the account that you want to create on an instance is available. |
Database management
| API | Title | Description |
|---|---|---|
| CreateDatabase | CreateDatabase | Creates a database on an instance. |
| DeleteDatabase | DeleteDatabase | Deletes a database from an instance. |
| ModifyDBDescription | ModifyDBDescription | Modifies the description of a database of an instance. |
| CopyDatabaseBetweenInstances | CopyDatabaseBetweenInstances | Replicates databases from one instance to another. |
| DescribeDatabases | DescribeDatabases | Queries the information about the databases of an instance. |
| DescribeCollationTimeZones | Query character set collations and time zones | You can call the DescribeCollationTimeZones operation to query the character set collations and time zones available for use in ApsaraDB RDS. |
| DescribeCharacterSetName | Query supported character sets | You can call the DescribeCharacterSetName operation to query the character sets that are supported for an ApsaraDB RDS instance. |
| ModifyCollationTimeZone | ModifyCollationTimeZone | You can call the ModifyCollationTimeZone operation to change the character set collation and time zone of system databases on an instance. |
| ModifyDBInstanceProxyConfiguration | ModifyDBInstanceProxyConfiguration | You can call the ModifyDBInstanceProxyConfiguration operation to configure the database proxy for an instance. |
| DescribeDBInstanceDetail | Query the details of an instance | You can call the DescribeDBInstanceDetail operation to query the details of an instance. |
| DescribeDBInstancesByPerformance | Query instances base on performance | You can call the DescribeDBInstancePerformance operation to query the performance of instances. |
| DescribeDBInstancesForClone | DescribeDBInstancesForClone | Queries a list of instances. |
| CopyDatabase | CopyDatabase | Replicates the databases of an ApsaraDB RDS instance that runs SQL Server 2008 R2 to another instance. |
Read-Only Instances
| API | Title | Description |
|---|---|---|
| CreateReadOnlyDBInstance | CreateReadOnlyDBInstance | Creates a read-only instance for an instance. |
| DescribeReadDBInstanceDelay | Query data replication latency | You can call the DescribeReadDBInstanceDelay operation to query the latency of data replication between a primary ApsaraDB RDS instance and its read-only instance. |
RDS Cluster Edition
| API | Title | Description |
|---|---|---|
| CreateDBNodes | CreateDBNodes | Add a node to a cluster. |
| DeleteDBNodes | Delete a node from an instance | You can call the DeleteDBNodes operation to delete a node from an instance. |
| DescribeDBInstanceEndpoints | DescribeDBInstanceEndpoints | Queries the information about the endpoint of an instance. |
| CreateDBInstanceEndpoint | CreateDBInstanceEndpoint | Creates an endpoint for an instance. |
| DeleteDBInstanceEndpoint | DeleteDBInstanceEndpoint | Deletes the endpoint of an instance. |
| ModifyDBInstanceEndpoint | ModifyDBInstanceEndpoint | Modifies the information about the endpoint of an instance. |
| CreateDBInstanceEndpointAddress | CreateDBInstanceEndpointAddress | Creates an endpoint for an instance. |
| DeleteDBInstanceEndpointAddress | DeleteDBInstanceEndpointAddress | Releases the public endpoint of an instance. |
| ModifyDBInstanceEndpointAddress | ModifyDBInstanceEndpointAddress | Modifies the information about the endpoint of an instance. |
Shared proxy (phased-out)
| API | Title | Description |
|---|---|---|
| AllocateReadWriteSplittingConnection | Apply for a read/write splitting endpoint | You can call the AllocateReadWriteSplittingConnection operation to apply for a read/write splitting endpoint for an ApsaraDB RDS instance. |
| ReleaseReadWriteSplittingConnection | Release the read/write splitting endpoint | You can call the ReleaseReadWriteSplittingConnection operation to release the read/write splitting endpoint of an ApsaraDB RDS instance. |
| CalculateDBInstanceWeight | Query system-assigned read weights | You can call the CalculateDBInstanceWeight operation to query the system-assigned read weights of a primary instance and its read-only instances. |
| ModifyReadWriteSplittingConnection | ModifyReadWriteSplittingConnection | Modifies the latency threshold that is allowed by the read/write splitting link and the read weights of a primary instance and its read-only instances. |
| DescribeDBInstanceProxyConfiguration | Query shared proxy settings | You can call the DescribeDBInstanceProxyConfiguration operation to query the settings of shared proxies that are enabled on an ApsaraDB RDS instance. |
Dedicated proxy (read/write splitting)
| API | Title | Description |
|---|---|---|
| ModifyDBProxy | ModifyDBProxy | Enables or disables the dedicated proxy feature for an instance. |
| UpgradeDBProxyInstanceKernelVersion | UpgradeDBProxyInstanceKernelVersion | Upgrades the dedicated proxy version of an instance. |
| ModifyDBProxyInstance | Modify the database proxy settings | You can call the ModifyDBProxyInstance operation to modify the database proxy settings of an ApsaraDB RDS instance. |
| ModifyDBProxyEndpoint | ModifyDBProxyEndpoint | Modifies the proxy endpoint that is used to connect to the dedicated proxy of an instance. |
| DescribeDBProxy | DescribeDBProxy | Queries the settings of the dedicated proxy for an instance. |
| DescribeDBProxyEndpoint | Query a proxy endpoint | You can call the DescribeDBProxyEndpoint operation to query the details about a proxy endpoint that is used to connect to the database proxy of an ApsaraDB RDS instance. |
| DescribeDBProxyPerformance | Query database proxy performance | You can call the DescribeDBProxyPerformance operation to query the performance metrics of the database proxy for an ApsaraDB RDS instance. |
| CreateDBProxyEndpointAddress | CreateDBProxyEndpointAddress | Creates an endpoint that is used to connect to the dedicated proxies of an instance. |
| ModifyDBProxyEndpointAddress | ModifyDBProxyEndpointAddress | Modifies the endpoint that is used to connect to the dedicated proxies of an instance. |
| DeleteDBProxyEndpointAddress | DeleteDBProxyEndpointAddress | Deletes the endpoint that is used to connect to the dedicated proxy of an instance. |
| ModifyDbProxyInstanceSsl | ModifyDbProxyInstanceSsl | Configures SSL encryption for the dedicated proxy endpoint of an instance. |
| GetDbProxyInstanceSsl | Query the SSL encryption settings | You can call the GetDbProxyInstanceSsl operation to query the SSL encryption settings of the dedicated proxy endpoint of an ApsaraDB RDS instance. |
Security management
| API | Title | Description |
|---|---|---|
| DescribeSecurityGroupConfiguration | Queries ECS security groups | Queries ECS security groups to which an ApsaraDB for RDS instance is added. |
| ModifySecurityGroupConfiguration | Changes the ECS security groups | Changes the ECS security groups to which an ApsaraDB for RDS instance is added. |
| ModifySecurityIps | ModifySecurityIps | Modifies an IP address whitelist of an instance. |
| DescribeDBInstanceSSL | DescribeDBInstanceSSL | Queries the SSL encryption settings of an instance. |
| ModifyDBInstanceSSL | ModifyDBInstanceSSL | Modifies the SSL encryption settings of an instance. |
| DescribeDBInstanceTDE | DescribeDBInstanceTDE | Queries the data encryption status of an instance. |
| ModifyDBInstanceTDE | ModifyDBInstanceTDE | Enables Transparent Data Encryption (TDE) for an instance. |
| MigrateSecurityIPMode | MigrateSecurityIPMode | Changes the whitelist mode of an instance from the standard whitelist mode to the enhanced whitelist mode. |
| DescribeDBInstanceIpHostname | DescribeDBInstanceIpHostname | Queries the hostname of the Elastic Compute Service (ECS) instance on which an ApsaraDB RDS instance runs. |
| ModifyDTCSecurityIpHostsForSQLServer | Configure a distributed transaction whitelist | Configures a distributed transaction whitelist for an ApsaraDB for RDS instance. |
| DescribeDTCSecurityIpHostsForSQLServer | Query distributed transaction whitelists | You can call the DescribeDTCSecurityIpHostsForSQLServer operation to query the distributed transaction whitelists of an ApsaraDB RDS instance. |
| CreateServiceLinkedRole | Create a service-linked role | You can call the CreateServiceLinkedRole operation to create a service-linked role. |
| ModifyDBInstanceDeletionProtection | ModifyDBInstanceDeletionProtection | Enables or disables the release protection feature for an instance. |
Log management
| API | Title | Description |
|---|---|---|
| ModifySQLCollectorPolicy | ModifySQLCollectorPolicy | You can call the ModifySQLCollectorPolicy operation to enable or disable the SQL Explorer (SQL Audit) feature for an instance. |
| DescribeSQLCollectorPolicy | Query SQL Explorer (SQL Audit) status | You can call the DescribeSQLCollectorPolicy operation to query the status of the SQL Explorer (SQL Audit) feature on an ApsaraDB RDS instance. |
| DescribeSQLLogRecords | DescribeSQLLogRecords | Queries the logs that are generated by the SQL Explorer (SQL Audit) feature for an instance. |
| DescribeSQLLogFiles | Query the audit log files | You can call the DescribeSQLLogFiles operation to query the audit log files that are generated by the SQL Explorer and Audit feature for an ApsaraDB RDS instance. |
| DescribeSlowLogs | Query the summary of slow query logs | You can call the DescribeSlowLogs operation to query the summary of the slow query logs of an ApsaraDB RDS instance. |
| DescribeSlowLogRecords | DescribeSlowLogRecords | Queries the details of the slow query logs of an instance. |
| DescribeErrorLogs | Query error logs | Queries error logs of an ApsaraDB for RDS instance within a specified time range. |
| PurgeDBInstanceLog | PurgeDBInstanceLog | Deletes log backup files from an instance. |
| DescribeSQLLogReportList | Query SQL log reports | You can call the DescribeSQLLogReportList operation to query SQL log reports. |
Backup and recovery
| API | Title | Description |
|---|---|---|
| CreateBackup | CreateBackup | Creates a backup set for an instance. |
| DescribeBackups | DescribeBackups | Queries the backup sets of an instance. |
| DescribeDetachedBackups | Query the data backup files of an instance that is deleted | You can call the DescribeDetachedBackups operation to query the data backup files of an instance that is deleted. |
| DescribeBackupPolicy | DescribeBackupPolicy | Queries the backup settings of an instance. |
| ModifyBackupPolicy | ModifyBackupPolicy | Modifies the backup settings of an instance. |
| DeleteBackup | DeleteBackup | Deletes a backup file of an instance. |
| DescribeBackupTasks | Query the backup tasks of an instance | You can call the DescribeBackupTasks operation to query the backup tasks of an instance. |
| DescribeBinlogFiles | DescribeBinlogFiles | Queries the binary log files of an instance. |
| DeleteBackupFile | DeleteBackupFile | Deletes backup files of an ApsaraDB RDS for SQL Server instance. |
| DescribeLogBackupFiles | DescribeLogBackupFiles | Queries the binary log files of an instance. |
Restoration
| API | Title | Description |
|---|---|---|
| RecoveryDBInstance | RecoveryDBInstance | Restores a database. |
| CloneDBInstance | CloneDBInstance | Restores the data of an original instance to a new instance. The new instance is called a cloned instance. |
| CreateTempDBInstance | CreateTempDBInstance | Creates a temporary instance. |
| DescribeLocalAvailableRecoveryTime | DescribeLocalAvailableRecoveryTime | You can call the DescribeLocalAvailableRecoveryTime operation to query the time range to which an instance can be restored. |
| RestoreTable | RestoreTable | Restores individual databases or tables of an instance to the original instance. |
| DescribeMetaList | DescribeMetaList | Queries the information about the restorable databases and tables in a backup set. |
Cross-region backup and restoration
| API | Title | Description |
|---|---|---|
| CheckCreateDdrDBInstance | Check cross-region backup | You can call the CheckCreateDdrDBInstance operation to check whether the data of a source ApsaraDB RDS instance can be restored to a destination ApsaraDB RDS instance by using a cross-region data backup file. |
| CreateDdrInstance | CreateDdrInstance | Restores the data of an instance to a new instance that resides in a different region. |
| RestoreDdrTable | RestoreDdrTable | Restores the data of an instance to an existing instance across regions. |
| ModifyInstanceCrossBackupPolicy | ModifyInstanceCrossBackupPolicy | Modifies the cross-region backup settings of an instance. |
| DescribeInstanceCrossBackupPolicy | Query cross-region backup settings of an instance | You can call the DescribeInstanceCrossBackupPolicy operation to query 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 | Query cross-region data backup files | You can call the DescribeCrossRegionBackups operation to query the cross-region data backup files of an instance. |
| DescribeCrossRegionLogBackupFiles | Query cross-region log backup files | You can call the DescribeCrossRegionLogBackupFiles operation to query the cross-region log backup files of an ApsaraDB RDS instance. |
| DescribeAvailableCrossRegion | Query the available destination regions | You can call the DescribeAvailableCrossRegion operation to query the available destination regions to which the cross-region backup files from a specified source region can be replicated. |
| DescribeAvailableRecoveryTime | Query the time range to which you can restore data by using a cross-region backup file | You can call the DescribeAvailableRecoveryTime operation to query the time range to which you can restore data by using a cross-region backup file. |
| DescribeCrossRegionBackupDBInstance | DescribeCrossRegionBackupDBInstance | You can call the DescribeCrossRegionBackupDBInstance operation to query the instances for which the cross-region backup feature is enabled in a region and the cross-region backup settings of these instances. |
Monitoring management
| API | Title | Description |
|---|---|---|
| DescribeResourceUsage | Query the storage usage | You can call the DescribeResourceUsage operation to query the storage usage of an ApsaraDB RDS instance. |
| DescribeDBInstancePerformance | Query performance metrics | You can call the DescribeDBInstancePerformance operation to query the performance metrics of an instance. |
| ModifyDBInstanceMonitor | Modify monitoring frequency | You can call the ModifyDBInstanceMonitor operation to modify the monitoring frequency of an ApsaraDB RDS instance. |
| DescribeAvailableMetrics | Query the enhanced monitoring metrics that are available for an instance | You can call the DescribeAvailableMetrics operation to query the enhanced monitoring metrics that are available for an instance. |
| ModifyDBInstanceMetrics | Modify displayed Enhanced Monitoring metrics | You can call the ModifyDBInstanceMetrics operation to modify the Enhanced Monitoring metrics that are displayed for an ApsaraDB RDS for PostgreSQL instance. |
| DescribeDBInstanceMetrics | Query the enhanced monitoring metrics that are enabled for an instance | You can call the DescribeDBInstanceMetrics operation to query the enhanced monitoring metrics that are enabled for an instance. |
Parameter management
| API | Title | Description |
|---|---|---|
| DescribeParameters | DescribeParameters | Queries the parameter settings of an instance. |
| ModifyParameter | ModifyParameter | Modifies the parameters of an instance. |
| DescribeModifyParameterLog | Query parameter configuration logs | Queries the parameter reconfiguration logs of an ApsaraDB for RDS instance. |
| DescribeParameterTemplates | Query parameter templates | Queries the parameter template of an ApsaraDB for RDS instance. |
| CreateParameterGroup | CreateParameterGroup | Creates a parameter template for an instance. |
| ModifyParameterGroup | ModifyParameterGroup | Modifies a parameter template of an instance. |
| CloneParameterGroup | CloneParameterGroup | Replicates a parameter template to the current region or to another region. |
| DescribeParameterGroups | Query parameter templates | You can call the DescribeParameterGroups operation to query parameter templates that are available in a region. |
| DescribeParameterGroup | Query information about a parameter template | You can call the DescribeParameterGroup operation to query information about a parameter template. |
| DeleteParameterGroup | DeleteParameterGroup | Deletes a parameter template from an instance. |
Data migration
| API | Title | Description |
|---|---|---|
| ImportDatabaseBetweenInstances | ImportDatabaseBetweenInstances | Migrates data across instances. |
| DescribeTasks | Query the tasks | You can call the DescribeTasks operation to query the tasks that are running on an instance. |
| DescibeImportsFromDatabase | DescibeImportsFromDatabase | You can call the DescibeImportsFromDatabase operation to query a single or all migration tasks of an instance. |
| API | Title | Description |
|---|---|---|
| ModifyActiveOperationTasks | ModifyActiveOperationTasks | Changes the switching time of scheduled O\\\&M tasks for an instance. |
| DescribeActiveOperationTasks | DescribeActiveOperationTasks | Queries the information about scheduled O\\\&M tasks for an instance. |
Migrate MySQL to the cloud
| API | Title | Description |
|---|---|---|
| ImportUserBackupFile | ImportUserBackupFile | Imports the full backup file of a self-managed MySQL database into an ApsaraDB RDS for MySQL instance. |
| ListUserBackupFiles | ListUserBackupFiles | Queries the details about one or more full backup files that are imported into an instance. |
| DeleteUserBackupFile | DeleteUserBackupFile | Deletes a full backup file. |
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. |
| DescribeMigrateTasks | DescribeMigrateTasks | Queries the tasks that are created to migrate the backup data of an ApsaraDB RDS for SQL Server instance. |
| DescribeOssDownloads | Query the backup file details | You can call the DescribeOssDownloads operation to query the backup file details of a backup data migration task for 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. |
| DescribeMigrateTaskById | DescribeMigrateTaskById | Queries a single task that is used to migrate the backup data of an ApsaraDB RDS for SQL Server instance to an Object Storage Service (OSS) bucket. |
SQL Server Active Directory (AD) domain
| API | Title | Description |
|---|---|---|
| ModifyADInfo | Modify the information about the AD domain | You can call the ModifyADInfo operation to modify the information about the Active Directory (AD) domain of an ApsaraDB RDS for SQL Server instance. |
| DeleteADSetting | DeleteADSetting | Deletes an instance from its domain. |
| DescribeADInfo | Query the information about the AD domain | You can call the DescribeADInfo operation to query the information about the Active Directory (AD) domain of an ApsaraDB RDS for SQL Server instance. |
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. |
| DescribeCloudMigrationPrecheckResult | DescribeCloudMigrationPrecheckResult | Queries the assessment report for cloud migration to an ApsaraDB RDS for PostgreSQL instance. |
| CreateCloudMigrationTask | CreateCloudMigrationTask | Creates a cloud migration task for an ApsaraDB RDS for PostgreSQL instance. |
| ActivateMigrationTargetInstance | ActivateMigrationTargetInstance | Switches workloads over to an ApsaraDB RDS for PostgreSQL instance. |
| DescribeCloudMigrationResult | DescribeCloudMigrationResult | Queries the details of the cloud migration tasks of an ApsaraDB RDS for PostgreSQL instance. |
Tag management
| API | Title | Description |
|---|---|---|
| ListTagResources | Query the tags of ApsaraDB RDS instances | You can call the ListTagResources operation to query tags that are bound to one or more ApsaraDB RDS instances. |
| DescribeTags | DescribeTags | Queries tags of an instance. |
| TagResources | Create and add a tag | You can call the TagResources operation to create and add tags to instances. |
| UntagResources | UntagResources | Removes tags from instances. |
| AddTagsToResource | Bind tags | You can call the AddTagsToResource operation to bind existing or new tags to an ApsaraDB RDS instance. |
| RemoveTagsFromResource | Remove tags from resource | Remove tags from resource. |
Other APIs
| API | Title | Description |
|---|---|---|
| User secrets | User secrets | |
| CreateSecret | Create a credential | You can call the CreateSecret operation to create a credential for a user who uses the Data API feature. |
| DescribeSecrets | DescribeSecrets | Queries the credential of the user who uses the Data API feature. |
| DeleteSecret | DeleteSecret | Deletes the credential of a user who uses the Data API feature. |
| Dedicated cluster management | Dedicated cluster management | |
| CheckServiceLinkedRole | Check whether an SLR is created | You can call the CheckServiceLinkedRole operation to check whether a service-linked role (SLR) is created. |
| DescribeDedicatedHostGroups | Query dedicated clusters | You can call the DescribeDedicatedHostGroups operation to query the information about one or more dedicated clusters. |
| DescribeDedicatedHosts | Query hosts in dedicated cluster | You can call the DescribeDedicatedHosts operation to query the information about one or more hosts in a dedicated cluster. |
| RebuildDBInstance | Rebuild instance | You can call the RebuildDBInstance operation to rebuild the secondary instance of a primary ApsaraDB RDS instance in a dedicated cluster. |
| DescribeDBMiniEngineVersions | Query available minor engine versions | You can call the DescribeDBMiniEngineVersions operation to query minor engine versions that are available for ApsaraDB RDS for MySQL instances and ApsaraDB RDS for PostgreSQL instances. |
| MigrateConnectionToOtherZone | MigrateConnectionToOtherZone | Migrates an instance to a different zone. |
| DescribeBackupDatabase | DescribeBackupDatabase | Queries the databases that are involved in a backup file. |
| DescribeDBInstanceEncryptionKey | Check whether disk encryption is enabled for an instance | 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. |
| DescribeRegionInfos | Query the regions | You can call the DescribeRegionInfos operation to query the regions. |
| DescribeDBInstanceByTags | DescribeDBInstanceByTags | Queries the tags that are added to an instance. |
| DescribeDBInstanceNetInfoForChannel | DescribeDBInstanceNetInfoForChannel | Queries all endpoints of an instance. |
| ModifyDBInstanceDelayedReplicationTime | Set the replication latency for a read-only ApsaraDB RDS for MySQL instance | You can call the ModifyDBInstanceDelayedReplicationTime operation to set the replication latency for a read-only ApsaraDB RDS for MySQL instance. |
| ReceiveDBInstance | Switch a primary instance to a disaster recovery instance | You can call the ReceiveDBInstance operation to switch a primary instance to a disaster recovery instance. |
| SwitchGuardToMasterInstance | Switch a disaster recovery instance to a primary instance | You can call the SwitchGuardToMasterInstance to switch a disaster recovery instance to a primary instance. |
| DescribeSlots | DescribeSlots | Queries the information about all replication slots of an instance. |
| DeleteSlot | DeleteSlot | Deletes a replication slot of an instance. |