V2(2022-01-01)

API overview

This topic summarizes the APIs available in RDS for PostgreSQL.

tip

In a single region, the API flow control limit of RDS for PostgreSQL is 20 times/second, that is, a single Volcano Engine account cannot call a single API interface more than 20 times per second. If this limit is exceeded, the API request execution will fail and an AccountFlowLimitExceeded error will be prompted.

Global

API	Note
DescribeRegions	Call the DescribeRegions API to query the list of available regions.
DescribeAvailabilityZones	Call the DescribeAvailabilityZones API to query the list of availability zones (AZs).

Managing instances

API	Note
CreateDBInstance	Call CreateDBInstance API to create an instance.
DescribeDBInstances	Call the DescribeDBInstances API to query a list of instances.
DescribeDBInstanceDetail	Call DescribeDBInstanceDetail API to query instance details.
DescribeDBInstanceSpecs	Call the DescribeDBInstanceSpecs API to query instance specifications available for sale.
DescribeDBInstancePriceDetail	Call the DescribeDBInstancePriceDetail API to query instance price details.
DescribeDBInstancePriceDifference	Call the DescribeDBInstancePriceDifference API to query instance price difference.
ModifyDBInstanceName	Call the ModifyDBInstanceName API to modify the instance name.
ModifyDBInstanceSpec	Call the ModifyDBInstanceSpec API to modify instance configurations.
ModifyDBInstanceChargeType	Call the ModifyDBInstanceChargeType API to modify the billing type of an instance.
ModifyDBInstanceAvailabilityZone	Call the ModifyDBInstanceAvailabilityZone API to migrate nodes from one AZ to another AZ in the same region.
AddTagsToResource	Call the AddTagsToResource API to add tags to an instance.
RemoveTagsFromResource	Call the RemoveTagsFromResource API to remove tags from an instance.
RestartDBInstance	Call the RestartDBInstance API to restart an instance.
DeleteDBInstance	Call the DeleteDBInstance API to delete an instance.
ModifyDBInstanceMaintenanceWindow	Call the ModifyDBInstanceMaintenanceWindow API to modify the maintenance window of an instance.

Managing databases

API	Note
CreateDatabase	Call the CreateDatabase API to create a database.
DescribeDatabases	Call the DescribeDatabases API to query a list of databases.
ModifyDatabaseOwner	Call the ModifyDatabaseOwner API to modify the database owner.
CloneDatabase	Call the CloneDatabase API to clone an existing database.
DeleteDatabase	Call the DeleteDatabase API to delete a database.

Managing accounts

API	Note
CreateDBAccount	Call the CreateDBAccount API to create an account.
DescribeDBAccounts	Call the DescribeDBAccounts API to query a list of accounts.
ModifyDBAccountPrivilege	Call the ModifyDBAccountPrivilege API to modify the database account permissions.
RevokeDBAccountPrivilege	Call the RevokeDBAccountPrivilege API to revoke authorization to database accounts.
ResetDBAccount	Call the ResetDBAccount API to reset the account password.
DeleteDBAccount	Call the DeleteDBAccount API to delete an account.

Managing schemas

API	Note
CreateSchema	Call the CreateSchema API to create a schema.
DescribeSchemas	Call the DescribeSchemas API to query a list of schemas.
ModifySchemaOwner	Call the ModifySchemaOwner API to modify the schema owner.
DeleteSchema	Call the DeleteSchema API to delete a schema.

Managing connections

API	Note
CreateDBEndpoint	Call the CreateDBEndpoint API to create an endpoint for the specified instance.
ModifyDBEndpointName	Call the ModifyDBEndpointName API to modify the connection endpoint name.
ModifyDBInstanceConfig	Call the ModifyDBInstanceConfig API to set whether to enable the global read-only mode for the instance.
ModifyDBEndpointReadWeight	Call the ModifyDBEndpointReadWeight API to modify the read weight distribution mode and custom weight ratio of an endpoint.
ModifyDBEndpointReadWriteFlag	Call the ModifyDBEndpointReadWriteFlag API to enable or disable read-write separation.
ModifyDBEndpointReadWriteDelayThreshold	Call the ModifyDBEndpointReadWriteDelayThreshold API to modify the read-only latency threshold of an endpoint.
ModifyDBEndpointAddress	Call the ModifyDBEndpointAddress API to modify the instance address.
CreateDBEndpointPublicAddress	Call the CreateDBEndpointPublicAddress API to create a public address.
DeleteDBEndpointPublicAddress	Call the DeleteDBEndpointPublicAddress API to delete a public endpoint address.
DescribeDBInstanceProxyParameters	Call the DescribeDBInstanceProxyParameters API to query the connection parameter configuration after read-write separation is enabled on the default endpoint of an instance.
ModifyDBEndpointProxyConfig	Call the ModifyDBEndpointProxyConfig API to modify the number of read/write separation proxy connections for the connection endpoint.
DeleteDBEndpoint	Call the DeleteDBEndpoint API to delete a connection endpoint.

Managing parameters

API	Note
DescribeDBInstanceParameters	Call the DescribeDBInstanceParameters API to query instance parameters.
ModifyDBInstanceParameters	Call the ModifyDBInstanceParameters API to modify instance parameters.
DescribeDBInstanceParametersLog	Call the DescribeDBInstanceParametersLog API to query the modification history of an instance parameter.
DescribeDBEngineVersionParameters	Call the DescribeDBEngineVersionParameters API to query the list of parameters supported for a specified database engine version.
CreateParameterTemplate	Call the CreateParameterTemplate API to create a parameter template.
ListParameterTemplates	Call the ListParameterTemplates API to query the parameter templates of the account in the current region.
DescribeParameterTemplate	Call the DescribeParameterTemplate API to query the details of the parameter template.
DescribeApplyParameterTemplate	Call the DescribeApplyParameterTemplate API to query the parameter changes after applying the parameter template (only query, not actually apply).
SaveAsParameterTemplate	Call the SaveAsParameterTemplate API to export the current parameter configuration of the instance as a parameter template.
CloneParameterTemplate	Call the CloneParameterTemplate API to clone the parameter template.
ModifyParameterTemplate	Call the ModifyParameterTemplate API to modify a parameter template.
DeleteParameterTemplate	Call the DeleteParameterTemplate API to delete a parameter template.

Backup and recovery

API	Note
CreateBackup	Call the CreateBackup API to create a data backup.
DescribeBackups	Call the DescribeBackups API to query a list of backups.
DescribeDetachedBackups	Call the DescribeDetachedBackups API to query the backup of a deleted instance.
DescribeRecoverableTime	Call the DescribeRecoverableTime API to query the time range for data recovery from an instance backup.
DescribeBackupPolicy	Call the DescribeBackupPolicy API to query the backup policy.
ModifyBackupPolicy	Call the ModifyBackupPolicy API to modify the backup policy.
DownloadBackup	Call the DownloadBackup API to download a backup.
GetBackupDownloadLink	Call the GetBackupDownloadLink API to obtain the download link of the backup.
RestoreToNewInstance	Call the RestoreToNewInstance API to restore data to a new instance.
RestoreToExistedInstance	Call the RestoreToExistedInstance API to restore data to an existing instance.
DeleteBackup	Call the DeleteBackup API to delete the data backup.
DescribeSlots	Call the DescribeSlots API to query the replication slots of the instance.
DeleteSlot	Call the DeleteSlot API to delete the replication slot.
DescribeWALLogBackups	Call the DescribeWALLogBackups API to obtain the list of backed-up WAL logs for the specified instance.

Logs

API	Note
DescribeFailoverLogs	Call the DescribeFailoverLogs API to query the primary/secondary switchover log of the instance.

Event management

API	Note
DescribePlannedEvents	Call the DescribePlannedEvents API to query the operation and maintenance events in the current region.
ModifyPlannedEventExecuteTime	Call the ModifyPlannedEventExecuteTime API to modify the execution time of operation and maintenance events.

Data security

API	Note
DescribeAllowLists	Call the DescribeAllowLists API to query the allowlists list in a specific region.
DescribeAllowListDetail	Call the DescribeAllowListDetail API to query the allowlist details.
CreateAllowList	Call the CreateAllowList API to create an allowlist.
ModifyAllowList	Call the ModifyAllowList API to modify the allowlist.
AssociateAllowList	Call the AssociateAllowList API to associate an allowlist.
DisassociateAllowList	Call the DisassociateAllowList API to disassociate an allowlist.
DeleteAllowList	Call the DeleteAllowList API to delete an allowlist.
UnifyNewAllowList	Call the UnifyNewAllowList API to merge some allowlists of multiple instances into a new allowlist.
UpgradeAllowListVersion	Call the UpgradeAllowListVersion API to upgrade the version of an allowlist.
DescribeDBInstanceSSL	Call the DescribeDBInstanceSSL API to query the SSL settings of the specified instance.
ModifyDBInstanceSSL	Call the ModifyDBInstanceSSL interface to modify the SSL configuration of the specified instance.
DownloadSSLCertificate	Call the DownloadSSLCertificate API to download the SSL certificate of the specified instance.

Managing tasks

API	Note
DescribeTasks	Call the DescribeTasks API to query tasks.
ModifyTask	Call the ModifyTask API to edit the task.

Last updated: 2026.03.31 10:45:17