You need to enable JavaScript to run this app.
RDS for PostgreSQL

RDS for PostgreSQL

Copy page
Download PDF
V2(2022-01-01)
API release history
Copy page
Download PDF
API release history
October 2026​
​
API​
Release date​
Change log​
Related functions​
2026-10-15​
New API.​
SQL throttling​
​
​
​
​
​
​
​
​
​
​
​
​
​
Updated the value range of request parameter DBEngineVersion, adding PostgreSQL_18.​
update DescribeBackups​
​
Updated the return parameter DBEngineVersion value range to include PostgreSQL_18.​
​
​
​
​
​
​
​
​
​
Updated the value range of request parameter DBEngineVersion, adding PostgreSQL_18.​
​
Updated the return parameter DBEngineVersion value range to include PostgreSQL_18.​
​
Updated the value range of request parameter DBEngineVersion, adding PostgreSQL_18.​
​
​
​
​
​
​
update Common structure - BasicInfoObject​
​
Updated the parameter DBEngineVersion value range, adding PostgreSQL_18.​
-​
update Common structure - InstanceInfoObject​
​
​
​
update Common structure - InstanceObject​
​
​
​
update Common structure - InstanceSpecObject​
​
​
​
​
June 2026​
​
API​
Release date​
Change log​
Related functions​
2026-06-03​
Added request parameters TDEEnable and KMSTrn.​
Managing instances​
​
Add response parameters TDEEnable and KMSTrn.​
​
​
April 2026​
​
API​
Release date​
Change log​
Related functions​
update CreateAllowList​
2026-04-16​
Updated the description of request parameters UserAllowList and AllowList, adding explanations on the validity of values when both are passed simultaneously.​
Data security​
​
March 2026​
​
API​
Release date​
Change log​
Related functions​
2026-03-30​
Update the description of parameter StorageSpace due to different specification supporting storage space ranges​
Managing instances​
​
​
​
​
​
​
​
​
​
​
​
Backup and recovery​
update Common structure - InstanceSpecObject​
​
Added parameters StorageSpaceMax and StorageSpaceMin to specify the maximum and minimum storage space supported by the current specification respectively.​
​
January 2026​
​
API​
Release date​
Change log​
Related functions​
2026-01-09​
Updated the request type of the API from "Sync request" to "Async request".​
Managing connections​
​
​
Managing parameters​
​
Added the request parameter MaintenanceWindow.​
Managing instances​
​
Added return parameter MaintenanceWindow.​
​
​
​
​
​
Added the request parameters SwitchType, SwitchType, and SpecifiedSwitchEndTime.​
​
​
Added the request parameter MaintenanceWindow.​
Backup and recovery​
​
New API.​
Event management​
add ModifyTask​
​
​
Managing tasks​
​
December 2025​
​
API​
Release date​
Change log​
Related functions​
2025-12-02​
Added a new API: DescribeWALLogBackups to retrieve the list of backed-up WAL logs for a specified instance.​
Backup and recovery​
​
Added PrivateNetworkVpcId parameter for filtering instances using the specified virtual private cloud.​
Managing instances​
​
Added return parameter NoneKernelParameters to return the current parameter configuration of the instance (non-kernel parameters).​
Managing parameters​
​
October 2025​
​
API​
Release date​
Change log​
Related functions​
2025-10-13​
  • Added return parameter DataIncrBackupPeriods to describe the backup frequency for the backup method as normal frequency, with a prompt that if the instance does not enable incremental backup, this field will not be returned.​
  • Added return parameter HourlyIncrBackupEnable to describe whether the high frequency backup function is enabled.​
  • Modified the return parameter IncrementBackupFrequency description, add the 12 value for high frequency incremental backup frequency, and explain that this parameter only takes effect when HourlyIncrBackupEnable is set to true.​
Backup and recovery​
​
  • Added to the prompt of the FullBackupPeriod parameter: choose at least one day each week for full backup.​
  • Added parameter DataIncrBackupPeriods: sets the backup frequency for incremental backups with normal frequency. Values must not overlap with the full backup schedule, and up to six days per week can be selected for incremental backup.​
  • Added parameter HourlyIncrBackupEnable: controls whether to enable high-frequency backup.​
  • Modified the description of the IncrementBackupFrequency parameter: added value 12 and clarified this applies only when HourlyIncrBackupEnable is true.​
​
October.14 2025​
  • The StorageType parameter is added to the body parameter of DescribeDBInstances API to specify the instance storage type, and the fixed value LocalSSD (local SSD disk) is used.​
  • The CrossRegionDomain parameter is added to the AddressObject structure to indicate the private network address accessible across regions. This field is not returned if no such address exists.​
  • The DomainVisibilitySetting parameter is added to the AddressObject structure to indicate the private network address type. The values are LocalDomain (local domain name) or CrossRegionDomain (cross-region accessible domain name).​
Managing instances​
​
  • Added CrossRegionDomain parameter in AddressObject to describe private network addresses accessible across regions.​
  • Added DomainVisibilitySetting parameter in AddressObject to describe private network address types, including local domain names and cross-region accessible domain names.​
​
2025-10-13​
  • Added StorageType request parameter to specify instance storage type, fixed value LocalSSD (local SSD disk).​
  • Added StorageType field to the returned parameter InstanceSpecObject to return the instance storage type information, with a fixed value of LocalSSD (local SSD disk).​
​
​
  • Added EstimateOnly parameter to initiate configuration adjustment evaluation. When set to true, it returns EstimationResult, which describes the impact of this configuration adjustment.​
  • Added EstimationResult field to the returned parameters to describe the estimated impact on the instance based on the current configuration change.​
  • Added description to the OrderId field in the returned parameters. When EstimateOnly is set to true, this field returns empty.​
  • Added ModifyDBInstanceSpecEstimationResult object, containing Plans and Effects fields, which describe the impact on the instance and read/write connections after the modification.​
​
​
Added DescribeDBInstanceSSL API to query the SSL settings of the specified instance. This API supports querying the following information:​
  • Protected address​
  • Force encryption status​
  • SSL certificate validity​
  • SSL function enabled status​
  • SSL certificate expiration time​
  • Supported TLS versions​
Data security​
​
Added the ModifyDBInstanceSSL interface to modify the SSL configuration of the specified instance. This interface supports the following functions:​
  • Enabled or disabled SSL encryption (via SSLEnable parameter)​
  • Updated SSL certificate validity period (via ReloadSSLCertificate parameter)​
  • Enabled or disabled SSL force encryption (via ForceEncryption parameter)​
  • Updating the SSL certificate validity and force encryption features only take effect when the instance has the SSL encryption feature enabled.​
  • It does not support passing ReloadSSLCertificate and SSLEnable parameters at the same time;​
​
​
Added the DownloadSSLCertificate interface to download the SSL certificate of the specified instance. This API requires an instance ID as a mandatory parameter and returns a compressed certificate package.​
​
​
Added DescribeTasks API to query task information. This API supports querying task details by task ID or task time range and returns the execution status, duration, creation time, and other information of the task.​
Managing tasks​
​
August 2025​
​
API​
Release date​
Change log​
Related functions​
2025-08-26​
- Added return parameter AssociatedInstanceNum.​
​
July 2025​
​
API​
Release date​
Change log​
Related functions​
2025-07-31​
- Added AllowListIds parameter for associating allowlists. Support associating multiple allowlists, separated by English commas. A single instance can associate up to 100 allowlists.​
update DescribeBackups​
​
- Added AllowListIds parameter in InstanceInfoObject to describe the allowlist information associated with the backup instance.​
-​
​
- Added AllowListIds parameter in the InstanceInfoObject structure to describe the allowlists bound to the instance to which the backup belongs.​
​
​
- Added AllowListIds parameter for associating with allowlists. Supports binding multiple allowlists, up to 100 allowlists can be associated.​
​
- Added MaxDelayTime parameter to indicate the latest postponed time of operation and maintenance events, formatted as yyyy-MM-ddTHH:mm:ss.sssZ (UTC time).​
​
  • Added request parameter AllowListCategory to specify allowlist category, with values including Ordinary (ordinary allowlist) and Default (default allowlist), defaulting to Ordinary.​
  • Added request parameter AllowListDesc for fuzzy search of allowlists by description.​
  • Added request parameter AllowListId for querying by allowlist ID.​
  • Added request parameter AllowListName for querying by allowlist name.​
  • Added request parameter IPAddress to support querying allowlists by IP address. Multiple IP addresses can be separated by commas.​
  • Added request parameter PageNumber to specify the current page number. The default value is 1.​
  • Added request parameter PageSize to specify the number of records per page. No default value.​
  • Added return parameter Total to indicate the total number of allowlists.​
  • Added field AllowListCategory in AllowListObject to indicate the allowlist category.​
  • Added field SecurityGroupBindInfos in AllowListObject to indicate security group binding information for allowlists, including security group ID, name, IP list, and association mode.​
  • Added data structure SecurityGroupBindInfo to describe security group binding information, including fields such as IpList, BindMode, SecurityGroupId, and SecurityGroupName.​
-​
​
  • Added return parameter AllowListCategory to identify the allowlist category, with values including Ordinary (ordinary allowlist) and Default (default allowlist). The default value is Ordinary.​
  • Added return parameter SecurityGroupBindInfos to describe the security group list bound to the allowlist, including IPs in the security group, associated security group mode, security group ID, and security group name.​
  • Added the return parameter UserAllowList to describe IP addresses or CIDR-formatted IP address segments outside the security groups that need to be added to the allowlist.​
​
update CreateAllowList​
​
  • AllowList parameter changed from required to optional, with a new prompt: this field cannot be used simultaneously with UserAllowList.​
  • Added AllowListCategory parameter to specify allowlist category, optional values: Ordinary (ordinary allowlist) and Default (default allowlist), default value is Ordinary.​
  • Added SecurityGroupBindInfos parameter to bind security group information to the allowlist, including subparameters IpList, BindMode, SecurityGroupId, and SecurityGroupName.​
  • Added UserAllowList parameter to specify IP addresses to be added to the allowlist outside the security group, this field cannot be used simultaneously with AllowList.​
  • Added SecurityGroupBindInfo data structure including fields IpList, BindMode, SecurityGroupId, and SecurityGroupName.​
update ModifyAllowList​
​
  • Added warning in ModifyMode parameter description: if the allowlist to be modified is bound to a security group, or if binding a security group when modifying the allowlist is required, then ModifyMode can only take the value Cover.​
  • Added AllowListCategory parameter to specify the allowlist category, with values Ordinary (ordinary allowlist) or Default (default allowlist). The default value is Ordinary.​
  • Added SecurityGroupBindInfos parameter to provide information for associating security groups with the allowlist, including IpList, BindMode, SecurityGroupId, and SecurityGroupName.​
  • Added UpdateSecurityGroup parameter to control whether to update the security groups bound to the allowlist, with values true (update) or false (no update). The default value is false.​
  • Added UserAllowList parameter to specify IP addresses to add to the allowlist outside of security groups, supporting both individual IP addresses and CIDR-format IP address ranges.​
  • Added SecurityGroupBindInfo structure to describe security group binding information, including IpList, BindMode, SecurityGroupId, and SecurityGroupName.​
​
June 2025​
​
API​
Release date​
Change log​
Related functions​
2025-06-04​
New API.​
​
​
​
​
​
​
​
​
​
​
​
​
-​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
update CreateBackup​
​
  • Added request parameters BackupScope, BackupMethod, BackupDescription, BackupMeta.​
  • Added the return parameter BackupId.​
update DescribeBackups​
​
  • Added request parameters DownloadStatus, BackupMethod, BackupDatabaseName, BackupDescription, CreateType, and BackupScope.​
  • Added return parameter BackupId.​
-​
​
Updated the description of the request parameter WriteNodeHaltWriting.​
​
​
​
​
add Common structure - BackupMetaObject​
​
Add a new struct.​
update Common structure - BackupObject​
​
  • Added parameters BackupDataSize, BackupDescription, BackupMeta, BackupMethod, BackupScope, and DownloadStatus.​
  • Updated value ranges for parameters BackupStatus, BackupType, and CreateType.​
​
April 2025​
​
API​
Release date​
Change log​
Related functions​
2025-04-22​
New API.​
​
​
-​
​
​
update CreateDatabase​
​
Updated the description of the request parameter Owner to include the restriction that Owner cannot be designated as a super account with disabled DDL permission or a normal account with disabled DDL permission.​
​
Updated the value range of request parameter DBEngineVersion, adding PostgreSQL_17.​
update CreateDBAccount​
​
Added optional request parameter NotAllowPrivileges.​
update CreateSchema​
​
Updated the description of the request parameter Owner to include the restriction that Owner cannot be designated as a super account with disabled DDL permission or a normal account with disabled DDL permission.​
​
Updated the value range of request parameter DBEngineVersion, adding PostgreSQL_17.​
-​
update DescribeDBInstanceSpecs​
​
​
​
update DescribeDBInstanceParameters​
​
Updated the return parameter DBEngineVersion value range to include PostgreSQL_17.​
​
​
Updated the description of the request parameter Owner to include the restriction that Owner cannot be designated as a super account with disabled DDL permission or a normal account with disabled DDL permission.​
​
Added the request parameter WriteNodeHaltWriting.​
​
  • Updated the descriptions of the request parameters ReadOnlyNodeMaxDelayTime and ReadOnlyNodeDistributionType.​
  • Add request parameters ReadWriteProxyConnection and WriteNodeHaltWriting.​
​
​
Updated the description of the request parameter SchemaInfoObject > Owner, adding the restriction that Owner cannot be set as a super account or normal account with DDL permissions disabled.​
add Common structure - PlannedEventsObject​
​
New common structure.​
update Common structure - AccountObject​
​
Added parameter NotAllowPrivileges.​
update Common structure - BasicInfoObject​
​
Updated the parameter DBEngineVersion value range, adding PostgreSQL_17.​
update Common structure - ChargeInfoObject​
​
Updated the parameter Number's value range.​
update Common structure - DatabaseObject​
​
Modified the description of parameter Owner. Added information that super accounts with DDL privileges disabled or normal accounts with DDL privileges disabled cannot be used as database owners.​
update Common structure - EndpointObject​
​
Added parameters ReadWriteProxyConnection and WriteNodeHaltWriting.​
update Common structure - InstanceInfoObject​
​
  • Updated the parameter DBEngineVersion value range, adding PostgreSQL_17.​
  • Added parameter Endpoints.​
update Common structure - InstanceObject​
​
Updated the parameter DBEngineVersion value range, adding PostgreSQL_17.​
update Common structure - InstanceSpecObject​
​
​
update Common structure - SchemaObject​
​
Modified the description of parameter Owner. Added information that super accounts with DDL privileges disabled or normal accounts with DDL privileges disabled cannot be used as schema owners.​
​
February 2025​
​
API​
Release date​
Change log​
Related functions​
update CreateDatabase​
2025-02-19​
Updated request parameter Ctype to CType.​
update DescribeBackups​
​
Updated return parameter StorageSpace type to Integer.​
-​
​
​
​
​
  • Updated the sample value of the request ParameterName.​
  • Updated the API return example.​
  • Added the descriptionZH field to the return parameters data structure.​
​
​
Removed the checkingCode, defaultValue, description, restart instance and type fields from the request parameter parameters data structure.​
update DescribeSlots​
​
  • Added the request parameter IPAddress.​
  • Added the IPAddress field to the return parameter ReplicationSlots data structure.​
update DeleteSlot​
​
Updated interface precautions.​
​
December 2024​
​
API​
Release date​
Change log​
Related functions​
2024-12-11​
Updated request parameter DBEngineVersion value range, adding PostgreSQL_15 and PostgreSQL_16.​
​
  • Added notes to the API.​
  • Updated request parameter DBEngineVersion value range, adding PostgreSQL_15 and PostgreSQL_16.​
-​
​
Updated the value range of return parameter DBEngineVersion to include PostgreSQL_15 and PostgreSQL_16.​
​
​
  • Added notes to the API.​
  • Updated request parameter DBEngineVersion value range, adding PostgreSQL_15 and PostgreSQL_16.​
​
​
Updated the description of the request parameters ApplyScope and CustomNodeIds.​
​
Updated description information for the parameter NodeOperateType.​
-​
​
​
​
​
Updated the description of request parameter Period.​
​
Updated the description of the request parameter All.​
update CreateDatabase​
​
Updated the description of request parameter Owner.​
​
Updated the description for the DBName parameter.​
-​
​
Updated the description for the AccountName field.​
​
update DescribeSchemas​
​
Updated the description for the DBName parameter.​
​
​
Updated the description for the EndpointName parameter.​
​
Updated the description for the GlobalReadOnly parameter.​
​
Updated the value range of the ReadOnlyNodeDistributionType request parameter.​
​
Updated the description of the request parameter ReadWriteSpliting.​
​
​
Added notes to the API.​
​
  • Updated the description of the request parameter ParameterName.​
  • Updated the value range of return parameter DBEngineVersion to include PostgreSQL_15 and PostgreSQL_16.​
-​
​
Updated the descriptions of the request parameter Type's value range and sample value.​
update DescribeBackups​
​
  • Updated the descriptions of the request parameters BackupId, BackupStartTime, BackupEndTime, BackupStatus, and BackupType.​
  • Updated the value range of return parameter DBEngineVersion to include PostgreSQL_15 and PostgreSQL_16.​
-​
​
Updated description for request parameters BackupRetentionPeriod, FullBackupTime, FullBackupPeriod, IncrementBackupFrequency, and WALLogSpaceLimitEnable.​
​
Updated description for request parameters InstanceId, InstanceName, BackupStartTime, BackupEndTime, ProjectName, BackupStatus, BackupType.​
-​
​
Updated description information for the parameter NodeOperateType.​
update DescribeSlots​
​
Updated the description of the request parameters SlotName, SlotType, Plugin, Database, Temporary, SlotStatus.​
-​
update DeleteSlot​
​
Updated the description of the request parameter All.​
​
Updated descriptions of request parameters QueryStartTime, QueryEndTime, and Context.​
​
update CreateAllowList​
​
Updated description information for request parameters AllowListName and AllowListDesc.​
update ModifyAllowList​
​
Updated description information for request parameters AllowListName, AllowListDesc, AllowList, ModifyMode, ApplyInstanceNum.​
​
Updated description information for request parameters AllowListName and AllowListDesc.​
​
October 2024​
​
API​
Release date​
Change log​
Related functions​
2024-10-24​
Added return parameter WALLogSpaceLimitEnable.​
​
Added request parameter WALLogSpaceLimitEnable.​
​
August 2024​
​
API​
Release date​
Change log​
Related functions​
2024-08-28​
Updated descriptions of parameters VpcId and SubnetId, adding restrictions on value ranges.​
​
​
​
July 2024​
​
API​
Release date​
Change log​
Related functions​
2024-07-30​
New API.​
add DeleteSlot​
​
​
​
Updated the valid range for the parameter DBEngineVersion.​
​
​
-​
​
​
​
​
Updated the return parameter DBEngineVersion value range.​
​
​
Updated the value range of parameter DBEngineVersion.​
​
update DescribeBackups​
​
​
​
​
​
​
​
June 2024​
​
API​
Release date​
Change log​
Related functions​
update ModifyDBEndpointAddress​
2024-06-20​
Updated API to add usage restrictions.​
update RestartDBInstance​
2024-06-12​
Updated API to add fields related to restarting specified read-only nodes.​
​
April 2024​
​
API​
Release date​
Change log​
Related functions​
add DescribeAllowLists​
2024-04-25​
New API.​
add DescribeAllowListDetail​
​
​
​
add CreateAllowList​
​
​
add ModifyAllowList​
​
​
add AssociateAllowList​
​
​
add DisassociateAllowList​
​
​
add DeleteAllowList​
​
​
add UnifyNewAllowList​
​
​
add UpgradeAllowListVersion​
​
​
​
Last updated: 2026.10.16 14:25:11