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

调试

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

请求参数

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

系统规定参数。取值：DescribeBackupPolicy。
DBClusterId String 是 pc-*************

集群ID。

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

返回数据

名称 类型 示例值 描述
PreferredBackupPeriod String Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday

数据备份周期，取值范围如下：

  • Monday：周一
  • Tuesday：周二
  • Wednesday：周三
  • Thursday：周四
  • Friday：周五
  • Saturday：周六
  • Sunday：周日
DataLevel1BackupRetentionPeriod String 7

一级备份保留周期，取值范围为3~14，单位为天。
RequestId String EADFCE0F-9FB5-4685-B395-1440B******

请求ID。
PreferredBackupTime String 07:00Z-08:00Z

执行自动备份的时间段，格式为HH:mmZ-HH:mmZ（UTC时间）。
BackupRetentionPolicyOnClusterDeletion String NONE

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

  • ALL：永久保留全部备份。
  • LATEST：永久保留最后一个备份。
  • NONE（默认）：不保留备份集。
PreferredNextBackupTime String 2020-11-16T07:30Z

下一次备份的时间，格式为YYYY-MM-DDThh:mmZ（UTC时间）。
DataLevel2BackupRetentionPeriod String 0

二级备份保留周期，取值范围如下：

  • 0：关闭二级备份功能。
  • 30～7300：二级备份保留周期，单位为天。
  • -1：二级备份永久保留。
    说明 创建集群时，默认取值为0，即关闭二级备份功能。
BackupFrequency String Normal

备份频率，取值如下：

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

备份频率，取值如下：

  • Normal（默认）：常规备份，每天定时备份一次。
  • 2/24H：高频备份，每2小时备份一次。
  • 3/24H：高频备份，每3小时备份一次。
  • 4/24H：高频备份，每4小时备份一次。
说明
  • PolarDB O引擎、PolarDB PostgreSQL引擎不支持该参数。
  • 如果您的PolarDB MySQL引擎所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见概述。
DataLevel1BackupPeriod String Monday,Tuesday

一级备份周期，取值范围如下：

  • Monday：周一
  • Tuesday：周二
  • Wednesday：周三
  • Thursday：周四
  • Friday：周五
  • Saturday：周六
  • Sunday：周日
说明
  • 至少需要选择2天，多个值之间用英文逗号（,）隔开。
  • PolarDB O引擎、PolarDB PostgreSQL引擎不支持该参数。
  • 如果您的PolarDB MySQL引擎所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见概述。
DataLevel1BackupTime String 15:00Z-16:00Z

执行自动备份的时间段，格式为hh:mmZ-hh:mmZ（UTC时间），且输入的数值必须为间隔1个小时的整点，如14:00Z-15:00Z。

说明
  • PolarDB O引擎、PolarDB PostgreSQL引擎不支持该参数。
  • 如果您的PolarDB MySQL引擎所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见概述。
DataLevel2BackupPeriod String Monday,Tuesday

二级备份周期，取值范围如下：

  • Monday：周一
  • Tuesday：周二
  • Wednesday：周三
  • Thursday：周四
  • Friday：周五
  • Saturday：周六
  • Sunday：周日
说明
  • 至少需要选择2天，多个值之间用英文逗号（,）隔开。
  • PolarDB O引擎、PolarDB PostgreSQL引擎不支持该参数。
  • 如果您的PolarDB MySQL引擎所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见概述。
DataLevel2BackupAnotherRegionRetentionPeriod String 30

二级备份跨地域备份保留周期。取值范围如下：

  • 0：关闭二级备份功能。
  • 30～7300：二级备份保留周期，单位为天。
  • 1：二级备份永久保留。
    说明 创建集群时，默认取值为0，即关闭二级备份跨地域备份功能。
DataLevel2BackupAnotherRegionRegion String cn-hangzhou

二级备份跨地域备份区域。跨地域备份支持的地域请参见概述。

示例

请求示例

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

正常返回示例

XML格式

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

<DescribeBackupPolicyResponse>
    <PreferredBackupPeriod>Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday</PreferredBackupPeriod>
    <DataLevel1BackupRetentionPeriod>7</DataLevel1BackupRetentionPeriod>
    <RequestId>EADFCE0F-9FB5-4685-B395-1440B******</RequestId>
    <PreferredBackupTime>07:00Z-08:00Z</PreferredBackupTime>
    <BackupRetentionPolicyOnClusterDeletion>NONE</BackupRetentionPolicyOnClusterDeletion>
    <PreferredNextBackupTime>2020-11-16T07:30Z</PreferredNextBackupTime>
    <DataLevel2BackupRetentionPeriod>0</DataLevel2BackupRetentionPeriod>
    <BackupFrequency>Normal</BackupFrequency>
    <DataLevel1BackupFrequency>Normal</DataLevel1BackupFrequency>
    <DataLevel1BackupPeriod>Monday,Tuesday</DataLevel1BackupPeriod>
    <DataLevel1BackupTime>15:00Z-16:00Z</DataLevel1BackupTime>
    <DataLevel2BackupPeriod>Monday,Tuesday</DataLevel2BackupPeriod>
    <DataLevel2BackupAnotherRegionRetentionPeriod>30</DataLevel2BackupAnotherRegionRetentionPeriod>
    <DataLevel2BackupAnotherRegionRegion>cn-hangzhou</DataLevel2BackupAnotherRegionRegion>
</DescribeBackupPolicyResponse>

JSON格式

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

{
  "PreferredBackupPeriod" : "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday",
  "DataLevel1BackupRetentionPeriod" : "7",
  "RequestId" : "EADFCE0F-9FB5-4685-B395-1440B******",
  "PreferredBackupTime" : "07:00Z-08:00Z",
  "BackupRetentionPolicyOnClusterDeletion" : "NONE",
  "PreferredNextBackupTime" : "2020-11-16T07:30Z",
  "DataLevel2BackupRetentionPeriod" : "0",
  "BackupFrequency" : "Normal",
  "DataLevel1BackupFrequency" : "Normal",
  "DataLevel1BackupPeriod" : "Monday,Tuesday",
  "DataLevel1BackupTime" : "15:00Z-16:00Z",
  "DataLevel2BackupPeriod" : "Monday,Tuesday",
  "DataLevel2BackupAnotherRegionRetentionPeriod" : "30",
  "DataLevel2BackupAnotherRegionRegion" : "cn-hangzhou"
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid. 指定的参数DBClusterId无效
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 当前的记录中不存在提供的DBClusterId。

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