ModifyBackupPolicy--云数据库 PostgreSQL 版-火山引擎

文档中心

立即注册

导航

ModifyBackupPolicy

最近更新时间：2025.10.14 14:43:14首次发布时间：2023.11.15 22:39:51

调用 ModifyBackupPolicy 接口修改备份策略。

请求类型

同步请求。

注意事项

如需关闭增量备份，需为请求参数 DataIncrBackupPeriods 传入空字符串，并为请求参数 HourlyIncrBackupEnable 传入 false。
如同时为请求参数 DataIncrBackupPeriods 传入非空的有效值，并为请求参数 HourlyIncrBackupEnable 传入 true，实例的增量备份方式为高频增量备份。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	postgres-ca7b7019****	实例 ID。
BackupRetentionPeriod	Integer	否	7	备份保留天数，取值范围为 7~365。说明无默认值。不传入该参数时则不修改原设定。
FullBackupTime	String	否	00:00Z-01:00Z	执行备份任务的时间。格式：`HH:mmZ-HH:mmZ`（UTC 时间）。说明无默认值。不传入该参数时则不修改原设定。
FullBackupPeriod	String	否	Monday	全量备份周期。多个取值用英文逗号（,）隔开。取值： `Monday`：周一 `Tuesday`：周二 `Wednesday`：周三 `Thursday`：周四 `Friday`：周五 `Saturday`：周六 `Sunday`：周日说明无默认值，不传入该参数时则不修改原设定。每周至少选择一天进行全量备份。
WALLogSpaceLimitEnable	Boolean	否	false	本地剩余可用空间保护功能状态。开启时，会在实例总存储空间占用率超过 80% 或者剩余空间不足 5GB 时，自动开始清除最早的本地 WAL 日志，直至总空间占用率低于 80% 且剩余空间大于 5GB。取值范围： `true`：开启。 `false`：关闭。说明无默认值。不传入该参数时则不修改原设定。
DataIncrBackupPeriods	String	否	Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday	增量备份的方式为正常增量时的备份频率，多个取值用英文逗号（,）隔开。取值： `Monday`：周一 `Tuesday`：周二 `Wednesday`：周三 `Thursday`：周四 `Friday`：周五 `Saturday`：周六 `Sunday`：周日说明取值不能与全量备份的周期重叠。每周最多可选择六天进行增量备份。
HourlyIncrBackupEnable	Boolean	否	true	是否开启高频备份功能。取值: `true`：是。 `false`：否。说明无默认值，不传入该参数时则不修改原设定。
IncrementBackupFrequency	Integer	否	2	增量备份的方式为高频增量时的备份频率。取值可为：`1`、`2`、`4`、`6` 或 `12`，单位：小时。说明无默认值。不传入该参数时则不修改原设定。该参数仅在 HourlyIncrBackupEnable 取值为 `true` 时生效。

返回参数

null

示例

请求示例

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
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023080411191113E74BF9DC0908068A0B",
        "Action": "ModifyBackupPolicy",
        "Version": "2022-01-01",
        "Service": "rds_postgresql",
        "Region": "cn-beijing"
    },
    "Result": null
}