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

文档中心

立即注册

导航

DescribeBackupPolicy

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

调用 DescribeBackupPolicy 接口查询备份策略。

请求类型

同步请求。

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	postgres-ca7b7019****	实例 ID。

返回参数

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

示例

请求示例

POST /?Action=DescribeBackupPolicy&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****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230804110353F956004F62ACD50597D6",
        "Action": "DescribeBackupPolicy",
        "Version": "2022-01-01",
        "Service": "rds_postgresql",
        "Region": "cn-beijing"
    },
    "Result": {
        "BackupRetentionPeriod": 7,
        "DataIncrBackupPeriods": "Tuesday",
        "FullBackupPeriod": "Monday,Wednesday,Friday",
        "FullBackupTime": "18:00Z-19:00Z",
        "HourlyIncrBackupEnable": false,
        "IncrementBackupFrequency": 12,
        "InstanceId": "postgres-36cd1f06e9f3",
        "WALLogSpaceLimitEnable": false
    }
}