调用DescribeBackupPolicy接口查看PolarDB集群的自动备份策略。

调试

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

请求参数

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

系统规定参数,取值为DescribeBackupPolicy

DBClusterId String pc-*************

集群ID。

说明 您可以调用 DescribeDBClusters接口查看目标地域下所有的集群信息,包括集群ID。

返回数据

名称 类型 示例值 描述
BackupFrequency String Normal

备份频率,取值如下:

  • Normal(默认):常规备份,每天定时备份一次。
  • 2/24H:增强备份,每2小时备份一次。
  • 3/24H:增强备份,每3小时备份一次。
  • 4/24H:增强备份,每4小时备份一次。
说明
  • 开启增强备份后,备份完成时间在24小时内的备份会全部保留。超过24小时的,系统将仅保留每日00:00点后完成的第一个备份,其他均被删除。
  • 开启增强备份后,备份周期PreferredBackupPeriod参数会默认选择一周内的所有天数(即从周一至周日)。
BackupRetentionPolicyOnClusterDeletion String NONE

删除集群时是否保留备份:

  • ALL:永久保留全部备份。
  • LATEST:永久保留最后一个备份。
  • NONE(默认):不保留备份集。
DataLevel1BackupRetentionPeriod String 7

一级备份保留周期,取值范围为3~14,单位为天。

DataLevel2BackupRetentionPeriod String 0

二级备份保留周期,取值范围如下:

  • 0:关闭二级备份功能。
  • 30~7300:二级备份保留周期,单位为天。
  • -1:二级备份永久保留。
    说明 创建集群时,默认取值为 0,即关闭二级备份功能。
PreferredBackupPeriod String Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday

数据备份周期,取值范围如下:

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

执行自动备份的时间段(UTC时间)。

PreferredNextBackupTime String 2020-11-16T07:30Z

下一次备份的时间(UTC时间)。

RequestId String EADFCE0F-9FB5-4685-B395-1440B******

请求ID。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=DescribeBackupPolicy
&DBClusterId=pc-*************
&<公共请求参数>

正常返回示例

XML格式

<DescribeBackupPolicyResponse>
      <PreferredBackupPeriod>Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday</PreferredBackupPeriod>
      <DataLevel1BackupRetentionPeriod>7</DataLevel1BackupRetentionPeriod>
      <RequestId>1CB29F6D-2FFE-49F5-B8D9-D3469F******</RequestId>
      <BackupRetentionPolicyOnClusterDeletion>NONE</BackupRetentionPolicyOnClusterDeletion>
      <PreferredBackupTime>07:00Z-08:00Z</PreferredBackupTime>
      <BackupFrequency>Normal</BackupFrequency>
      <PreferredNextBackupTime>2020-11-16T07:30Z</PreferredNextBackupTime>
      <BackupRetentionPeriod>7</BackupRetentionPeriod>
      <DataLevel2BackupRetentionPeriod>0</DataLevel2BackupRetentionPeriod>
</DescribeBackupPolicyResponse>

JSON格式

{
	"PreferredBackupPeriod": "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday",
	"DataLevel1BackupRetentionPeriod": 7,
	"RequestId": "1CB29F6D-2FFE-49F5-B8D9-D3469F******",
	"BackupRetentionPolicyOnClusterDeletion": "NONE",
    "PreferredBackupTime": "07:00Z-08:00Z",
    "BackupFrequency": "Normal",
	"PreferredNextBackupTime": "2020-11-16T07:30Z",
    "BackupRetentionPeriod": 7,
	"DataLevel2BackupRetentionPeriod": 0
}

错误码

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