调用DescribeBackupPolicy接口查看AnalyticDB PostgreSQL版实例的备份设置。

使用说明

周期性备份数据可以有效防止数据丢失,通过本接口您可以查看目标存储弹性模式实例的备份策略。如需修改备份策略,请参见ModifyBackupPolicy

QPS限制

本接口的单用户QPS限制默认为1000次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeBackupPolicy

系统规定参数。取值:DescribeBackupPolicy

DBInstanceId String gp-bp***************

实例ID。

说明 您可以调用DescribeDBInstances接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情,包括实例ID。

返回数据

名称 类型 示例值 描述
BackupRetentionPeriod Integer 7

数据备份保留天数。

RequestId String 9E6B3287-A3E2-5A87-B8D8-E9**********

请求ID。

PreferredBackupPeriod String Wednesday,Friday

数据备份周期,多个取值用英文逗号(,)隔开。取值说明:

  • Monday:周一。
  • Tuesday:周二。
  • Wednesday:周三。
  • Thursday:周四。
  • Friday:周五。
  • Saturday:周六。
  • Sunday:周日。
PreferredBackupTime String 12:00Z-13:00Z

数据备份时间。格式:HH:mmZ-HH:mmZ(UTC时间)。

RecoveryPointPeriod String 1

恢复点频次。取值说明:

  • 1:每小时。
  • 2:每两小时。
  • 4:每四小时。
  • 8:每八小时。
EnableRecoveryPoint Boolean true

是否开启自动恢复点。取值说明:

  • true:开启。
  • false:关闭。

示例

请求示例

http(s)://gpdb.aliyuncs.com/?Action=DescribeBackupPolicy
&DBInstanceId=gp-bp***************
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeBackupPolicyResponse>
    <PreferredBackupPeriod>Wednesday,Friday</PreferredBackupPeriod>
    <RequestId>9E6B3287-A3E2-5A87-B8D8-E9**********</RequestId>
    <PreferredBackupTime>12:00Z-13:00Z</PreferredBackupTime>
    <BackupRetentionPeriod>7</BackupRetentionPeriod>
    <EnableRecoveryPoint>true</EnableRecoveryPoint>
    <RecoveryPointPeriod>1</RecoveryPointPeriod>
</DescribeBackupPolicyResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PreferredBackupPeriod" : "Wednesday,Friday",
  "RequestId" : "9E6B3287-A3E2-5A87-B8D8-E9**********",
  "PreferredBackupTime" : "12:00Z-13:00Z",
  "BackupRetentionPeriod" : 7,
  "EnableRecoveryPoint" : true,
  "RecoveryPointPeriod" : "1"
}

错误码

访问错误中心查看更多错误码。