API overview
Updated at:
API standards and multilingual preset SDKs
The OpenAPI of this product (Rds/2014-08-15) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
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 | Manually renew an RDS instance | Manually renews a subscription ApsaraDB RDS instance. |
| DescribeDBInstancePromoteActivity | DescribeDBInstancePromoteActivity | The operation is phased out. |
Instances
|
API |
Title |
Description |
| CreateDBInstance | Create an RDS instance | Creates an ApsaraDB RDS instance. |
| CreateDBInstanceForRebuild | CreateDBInstanceForRebuild | Rebuilds an instance from the recycle bin. |
| DeleteDBInstance | Release an RDS instance | Releases an ApsaraDB RDS instance. |
| RestartDBInstance | RestartDBInstance | Restarts an instance. |
| StopDBInstance | StopDBInstance | Suspends an ApsaraDB RDS instance. |
| StartDBInstance | StartDBInstance | Resumes an instance. |
| ModifyDBInstanceSpec | Modify an RDS instance | Modifies the specifications and storage capacity of an ApsaraDB RDS instance. |
| DestroyDBInstance | Destroy an instance | Destroys an ApsaraDB RDS instance in the recycle bin. |
| ModifyDasInstanceConfig | ModifyDasInstanceConfig | Configures automatic storage expansion for an instance. |
| MigrateToOtherZone | MigrateToOtherZone | Migrates an RDS instance to a different availability zone. |
| 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 | Query instance details | Queries the details of an ApsaraDB RDS instance. |
| GetDBInstanceTopology | GetDBInstanceTopology | Queries the topology of an instance. |
| DescribeDBInstances | Query instance list | Queries a list of ApsaraDB RDS 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. |
| 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. |
| DescribeDBInstancesAsCsv | DescribeDBInstancesAsCsv | This API retrieves a list of instances. It is now deprecated. |
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 | Use this API to retrieve the pre-upgrade check report for a major version upgrade of RDS MySQL and RDS PostgreSQL. |
| DescribeUpgradeMajorVersionTasks | Query major version upgrade jobs for RDS PostgreSQL instances | This API is used to query the history of major version upgrade jobs for RDS PostgreSQL instances. |
| 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 | Pre-check for RDS major engine version upgrade | Performs a pre-upgrade check before a major engine version upgrade for ApsaraDB RDS for MySQL or ApsaraDB RDS for PostgreSQL instances. |
| UpgradeDBInstanceMajorVersion | UpgradeDBInstanceMajorVersion | Starts a major version upgrade for an RDS PostgreSQL instance. |
Network and connection addresses
|
API |
Title |
Description |
| AllocateInstancePublicConnection | Apply for a public endpoint | Applies for a public endpoint for an ApsaraDB RDS instance. |
| ReleaseInstancePublicConnection | Release the public endpoint of an instance | Releases the public endpoint of an instance. |
| ModifyDBInstanceConnectionString | Manage instance endpoint and port | Manages 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 | Modify configuration items of an apsaraDB RDS instance | Modifies the configuration items of an ApsaraDB RDS 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 | Query automatic primary/secondary switchover settings of an RDS instance | Queries the automatic switchover settings of an ApsaraDB RDS instance. |
| SwitchDBInstanceHA | SwitchDBInstanceHA | Switches workloads between primary and secondary ApsaraDB RDS instances. |
Historical events
|
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. |
Notifications
|
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. |
| DescribeRdsResourceSettings | DescribeRdsResourceSettings | Obtains the notification settings for instance resources. This operation can still be called but is no longer maintained. |
Accounts
|
API |
Title |
Description |
| CreateAccount | Create a database account | 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 | Query database account information | Queries the account information of 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 | Grant Database Access Permissions to an Account | This API is used to grant a specified database account access permissions to one or more databases. |
| 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. |
Databases
|
API |
Title |
Description |
| CreateDatabase | Create a database | Creates a database in an ApsaraDB RDS instance. |
| DeleteDatabase | DeleteDatabase | Deletes a database from an RDS instance. |
| CopyDatabase | CopyDatabase | Replicates the databases of an instance that runs SQL Server 2008 R2 to another instance. This operation is phased out. |
| 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 | This API lists the databases in an RDS 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 | Create a read-only instance | Creates a read-only instance for an ApsaraDB RDS 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. |
| PrecheckDuckDBDependency | PrecheckDuckDBDependency | Checks whether DuckDB-based analytical instances can be created for the specified RDS for PostgreSQL primary instance. If DuckDB-based analytical instances cannot be created, this operation returns the failure causes and provides solutions or recommended specification values. |
RDS cluster edition instances
|
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 | Modify the endpoint weight information of an instance | Modifies the endpoint weight information of an ApsaraDB RDS cluster instance. |
| 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. |
Database 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 minor kernel version of a database proxy. |
| 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 | Query PolarProxy details | This API is used to query the PolarProxy settings of an RDS instance. |
| DescribeDBProxyEndpoint | DescribeDBProxyEndpoint | This API retrieves the database proxy endpoint for an RDS instance. |
| DescribeDBProxyPerformance | Query Performance Data of PolarProxy | This API is used to query the performance data of the database proxy for an ApsaraDB RDS instance. |
| GetDbProxyInstanceSsl | GetDbProxyInstanceSsl | Queries the SSL encryption settings for a dedicated proxy endpoint of an ApsaraDB RDS for MySQL instance. |
Security and encryption
|
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 | Modify SSL configuration of an RDS instance | Modifies the SSL link configuration of an ApsaraDB RDS instance. |
| ModifyDBInstanceTDE | Modify TDE status of an RDS instance | Enables or modifies the Transparent Data Encryption (TDE) feature for an ApsaraDB RDS 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 | Query SSL configuration of an RDS instance | Queries the SSL configuration of an ApsaraDB RDS instance. |
| DescribeDBInstanceTDE | Query TDE status of an RDS instance | Queries the Transparent Data Encryption (TDE) status of an ApsaraDB RDS 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. |
Logs
|
API |
Title |
Description |
| DescribeSQLLogReportList | DescribeSQLLogReportList | Queries SQL log reports. |
| PurgeDBInstanceLog | PurgeDBInstanceLog | Clears the on-premises logs of an ApsaraDB RDS 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. |
| DescribeSlowLogs | DescribeSlowLogs | Queries the statistics on slow query logs. |
| DescribeSlowLogRecords | View Slow Query Log Details | This API is used to view the slow query log details of an instance. |
| DescribeErrorLogs | View error logs | Queries the error logs of an instance within a specified time range. |
| ModifySQLCollectorPolicy | ModifySQLCollectorPolicy | This operation can still be called but is no longer maintained. This operation 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 | Query SQL audit logs of an instance (deprecated) | Deprecated: can be called normally but is no longer maintained. Queries the SQL Explorer (SQL Audit) logs of an ApsaraDB RDS instance. |
| DescribeSQLCollectorRetention | DescribeSQLCollectorRetention | Queries the retention period of the log files that are generated by the SQL Explorer feature for an instance. |
Backup
|
API |
Title |
Description |
| CreateBackup | Create a Backup Set for an RDS Instance | Create a backup set for an RDS instance. |
| DeleteBackup | Delete data backup files of an instance | Deletes data backup files of an ApsaraDB RDS instance. |
| DeleteBackupFile | DeleteBackupFile | Deletes the backup files of an ApsaraDB RDS for SQL Server instance. This operation is available only for users that have been added to the whitelist of the instance. |
| ModifyBackupPolicy | Modify instance backup policy | Modifies the backup policy settings of an ApsaraDB RDS instance. |
| DescribeBackups | View the list of RDS instance backup sets | This API is used to view the backup set list of an RDS instance. |
| DescribeDetachedBackups | DescribeDetachedBackups | Queries the data backup files of an ApsaraDB RDS instance that is released. |
| DescribeBackupPolicy | View instance backup settings | Queries the backup settings of an ApsaraDB RDS 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. |
| DescribeBackupDatabase | DescribeBackupDatabase | Queries the databases that are involved in a backup file. |
Restoration
|
API |
Title |
Description |
| CreateTempDBInstance | Create a temporary instance | Creates a temporary instance for an ApsaraDB RDS for SQL Server 2008 R2 instance with Premium Local SSDs. |
| 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 | Restore Data (Clone Instance) | This API restores historical data to a new cloned instance. |
| RestoreTable | Restore specific databases or tables to the original RDS instance | Restores specific databases or tables of an ApsaraDB RDS 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
|
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. |
Parameters
|
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. |
O&M task management
|
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. |
PostgreSQL one-click migration to cloud
|
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. |
Tags
|
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. |
Manage RDS postgreSQL extensions
|
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. |
PostgreSQL instance replication slot management
|
API |
Title |
Description |
| DeleteSlot | DeleteSlot | Deletes a replication slot of an instance. |
| DescribeSlots | DescribeSlots | Queries all replication slots of an instance. |
Committed serverless
|
API |
Title |
Description |
| ModifyComputeBurstConfig | Modify or disable the committed serverless feature | Modifies or disables the committed Serverless feature. |
| DescribeComputeBurstConfig | DescribeComputeBurstConfig | Queries the settings of assured serverless. |
Others
|
API |
Title |
Description |
| User credentials | User credentials | |
| 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. |
| Hosts | Hosts | |
| 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. |
| ModifyDBInstanceReplicationSwitch | Modify instance native replication switch status | Enables or disables native replication mode for an ApsaraDB RDS instance by calling the ModifyDBInstanceReplicationSwitch operation. |
| DescribeDBInstanceReplication | Query Instance Replication Status | This API returns the status and configuration of native replication instances. |
| MigrateDBNodes | MigrateDBNodes | Changes the zone of a node from an ApsaraDB RDS for MySQL instance that runs RDS Cluster Edition. |
| SwitchOverMajorVersionUpgrade | Major Version Upgrade Switchover | Zero-downtime major version upgrade traffic switchover for RDS PostgreSQL. |
| AuthorizeBackupEncryption | Validate backup encryption | Create the AliyunServiceRoleForRdsBackupEncryption service-linked role. |
| CheckBackupEncryptionAuthorized | Query Validation Results for Backup Encryption | Check if the AliyunServiceRoleForRdsBackupEncryption service-linked role exists in the user account. |
| CheckRegionSupportBackupEncryption | Check whether the instance supports backup encryption | Check if the current region supports backup encryption. |
| DescribeSQLServerUpgradeVersions | Query SQL Server upgradable versions | Describes the versions to which an SQL Server instance or a specified SQL Server version can be upgraded. |
| DescribeVpcs | Query the virtual private cloud (VPC) list | Lists the Virtual Private Clouds (VPCs) in your Alibaba Cloud account. |
| EnableBackupEncryption | Enable backup encryption | Use this API to enable backup encryption. |
| DescribeActiveOperationMaintainConf | Query proactive O\&M configuration | Obtain the user's O\\&M configuration information, which currently includes scheduled management event time window information. |
| CreateMaskingRules | Create an Encryption or Desensitization Rule | Create a new encryption or desensitization rule for a specified instance. |
| ModifyAccountMaskingPrivilege | Modify Account Masking Permission | Modify the encryption or masking permissions of an account in a specified instance. |
| ModifyMaskingRules | Modify encryption or desensitization rule | Modifies the encryption or data masking rule for a specified instance. |
| DescribeMaskingRules | Query encryption or desensitization rules | Lists encryption or data masking rules for a specified instance. |
| DeleteMaskingRules | Delete an encryption or desensitization rule | Deletes the encryption or data desensitization rules for the specified instance. |
| DescribeAccountMaskingPrivilege | Query account encryption or data masking permissions | Retrieves the encryption or data masking permission configuration for an account in a specified instance. |
| DeleteParameterTimedScheduleTask | Delete a Scheduled Task for Parameter Modification | Deletes a scheduled task for modifying instance parameters. |
| DescribeParameterTimedScheduleTask | Query Scheduled Task for Modifying Instance Parameters | Queries the details of a scheduled task that modifies instance parameters. |
| ModifyParameterTimedScheduleTask | Modify Scheduled Task for Parameter Modification | Change the effective time of a scheduled parameter modification task. |
| DescribeDBInstanceCLS | Query Column Encryption Algorithm Configuration | Returns the column encryption algorithm configuration for a specified instance. |
| ModifyDBInstanceCLS | Modify Column Encryption Algorithm Configuration | Modifies the column encryption algorithm configuration for a specified instance. |
| CreateRCImage | CreateRCImage | Creates a custom image for an RDS Custom instance. |
| ModifyDBInstanceVectorSupportStatus | Modify the vector storage toggle for an instance | Enable or disable vector storage for a MySQL instance. |
| DescribeImportTaskValidation | Queries the Details of a Precheck for an Import Job | Queries the details of a precheck for an import task. This operation returns each precheck item and its result. |
| DescribeImportTask | Query import job details | Retrieves the details of a data import task for an RDS instance that uses native replication. |
| CreateImportTask | Create a Data Import Job | Creates a data import task. |
| ValidateImportTask | Precheck for Data Import Job | Runs a precheck on a data import task for an RDS for MySQL instance that uses native replication. |
| ListImportTasks | List Data Import Jobs | Queries the data import tasks for native replication. |
| ModifyImportTask | Modify Data Import Job | Modifies a data import task for an RDS MySQL native replication instance. |
| ModifyRCDiskAttribute | Modify block storage properties | Modifies the attributes of a block storage device, such as its name, description, whether it is released with its instance, and whether performance bursting is enabled. |
| UpdateDBInstanceReplication | Update replication channel | Updates a replication channel for a native replication instance. |
| CreateDBInstanceReplication | Create replication channel | Creates a replication link for a native replication instance. |
| DeleteDBInstanceReplication | Delete replication channel | Deletes a replication channel from a native replication instance. |
| ModifyDBInstance | Modify an instance | Modifies an instance. Currently, only the PostgreSQL engine is supported. |
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. |
Console operations
|
API |
Title |
Description |
| CreateYouhuiForOrder | Claim Coupon | This API is used to claim a coupon. |
| DescribeCurrentModifyOrder | Query the latest upgrade/downgrade order for an instance | Query the latest upgrade/downgrade order of an instance |
| DescribeCustinsResourceInfo | Query instance resource usage | Query instance resource usage |
| DescribeDBInstanceConnectivity | Query database instance connection | Obtain instance ingest endpoint diagnosis information |
| DescribeHostGroupElasticStrategyParameters | Query the elasticity policy configuration of a host group | Query the elasticity policy parameters of a host group |
| DescribeMarketingActivity | Query Marketing Campaigns | Obtain information about instances pending upgrade in the RDS Marketing project |
| DescribeQuickSaleConfig | Query quick sale Product configuration | Query RDS quick sale configuration |
| DescribeResourceDetails | Query resource details | Resource details on the overview page |
| EvaluateLocalExtendDisk | Evaluate local disk extension | Evaluate the available disk space for emergency local disk scale-out and unlock. |
| ModifyCustinsResource | Modify Instance Resources | This API is used to modify RDS instance resources. |
| PreCheckCreateOrderForDeleteDBNodes | Precheck for deleting an instance node | Precheck for deleting a node and creating an order |
| QueryRecommendByCode | Query RDS Hot Spot Questions | This API is used to query RDS bot hot spot questions. |
| CreateOrderForDeleteDBNodes | CreateOrderForDeleteDBNodes | Deletes a node from an ApsaraDB RDS for MySQL instance that runs RDS Cluster Edition. |
Is this page helpful?