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

RDS for PostgreSQL

Copy page
Download PDF
Backup and recovery
ModifyBackupPolicy
Copy page
Download PDF
ModifyBackupPolicy
Call the ModifyBackupPolicy API to modify the backup policy.​
Request type​
Synchronous request.​
Precautions​
  • To disable incremental backup, set the request parameter DataIncrBackupPeriods to an empty string and set the request parameter HourlyIncrBackupEnable to false.​
  • If a non-empty valid value is passed to the request parameter DataIncrBackupPeriods and true is passed to the request parameter HourlyIncrBackupEnable at the same time, the instance’s incremental backup method will be high-frequency incremental backup.​
Debug​
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
​
Request parameters​
​
Parameter​
Type​
Required?​
Example​
Description​
InstanceId​
String​
Yes​
postgres-ca7b7019****​
Instance ID.​
BackupRetentionPeriod​
Integer​
No​
7​
Backup retention days, with a range of 7 to 365.​
tip​
Default value. If this parameter is not provided, the original setting remains unchanged.​
FullBackupTime​
String​
No​
00:00Z-01:00Z​
The time to execute the backup task. Format: HH:mmZ-HH:mmZ (UTC time).​
tip​
Default value. The original setting will not be modified if this parameter is not passed.​
FullBackupPeriod​
String​
No​
Monday​
Full backup cycle. Multiple values separated by commas (,). Values:​
  • Monday: Monday​
  • Tuesday: Tuesday​
  • Wednesday: Wednesday​
  • Thursday: Thursday​
  • Friday: Friday​
  • Saturday: Saturday​
  • Sunday: Sunday​
tip​
  • No default value. If this parameter is not provided, the original setting remains unchanged.​
  • Select at least one day a week for full backup.​
WALLogSpaceLimitEnable​
Boolean​
No​
false​
Local remaining available space protection state. After enabling this feature, the instance automatically clears the earliest local WAL log when the total storage space usage exceeds 80% or the remaining space is less than 5GB, until usage drops below 80% and the remaining space exceeds 5GB. value range:​
  • true: enable.​
  • false: disabled.​
tip​
Default value. If this parameter is not provided, the original setting remains unchanged.​
DataIncrBackupPeriods​
String​
No​
Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday​
The backup frequency when the incremental backup method is normal frequency. Multiple values are separated by commas (,). Values:​
  • Monday: Monday​
  • Tuesday: Tuesday​
  • Wednesday: Wednesday​
  • Thursday: Thursday​
  • Friday: Friday​
  • Saturday: Saturday​
  • Sunday: Sunday​
tip​
  • The value cannot overlap with the full backup cycle.​
  • You can select up to six days per week for incremental backup.​
HourlyIncrBackupEnable​
Boolean​
No​
true​
Specifies whether to enable high-frequency backup. Value:​
  • true: yes.​
  • false: no.​
tip​
No default value. If this parameter is not provided, the original setting remains unchanged.​
IncrementBackupFrequency​
Integer​
No​
2​
Backup frequency when the incremental backup method is high-frequency. Values can be 1, 2, 4, 6 or 12. Unit: hours.​
tip​
  • Default value. If this parameter is not provided, the original setting remains unchanged.​
  • This parameter is valid only when HourlyIncrBackupEnable is true.​
​
Response parameter​
null​
Sample​
Sample request​
​
POST /?Action=ModifyBackupPolicy&Version=2022-01-01 HTTP/1.1​
Content-Type: application/json​
Host: rds-postgresql.cn-beijing.volcengineapi.com​
X-Date: 20231002T101010Z​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_postgresql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****​
{​
"InstanceId": "postgres-ca7b7019****",​
"BackupRetentionPeriod": 8,​
"FullBackupPeriod": "Monday,Wednesday,Friday",​
"FullBackupTime": "02:00Z-03:00Z",​
"HourlyIncrBackupEnable": true,​
"IncrementBackupFrequency": 4,​
"WALLogSpaceLimitEnable": false​
}​
​
Sample response​
​
{​
"ResponseMetadata": {​
"RequestId": "2023080411191113E74BF9DC0908068A0B",​
"Action": "ModifyBackupPolicy",​
"Version": "2022-01-01",​
"Service": "rds_postgresql",​
"Region": "cn-beijing"​
},​
"Result": null​
}​
​
Last updated: 2026.03.31 10:45:18