AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 云原生数据库 PolarDB 开发参考 PolarDB MySQL版/PostgreSQL版API参考 API参考指南 API目录 备份管理 备份策略 DescribeBackupPolicy - 查看PolarDB集群自动备份策略

DescribeBackupPolicy - 查看PolarDB集群自动备份策略

更新时间：
产品详情
我的收藏

查看PolarDB集群的自动备份策略。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardb:DescribeBackupPolicy

get

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

 无 无

请求参数

名称

类型

必填

描述

示例值
DBClusterId

string

是

集群 ID。

说明

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

pc-*************

返回参数

名称

类型

描述

示例值

object

PreferredBackupPeriod

string

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

  • Monday：周一

  • Tuesday：周二

  • Wednesday：周三

  • Thursday：周四

  • Friday：周五

  • Saturday：周六

  • Sunday：周日

Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday
DataLevel1BackupRetentionPeriod

string

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

7
RequestId

string

请求 ID。

EADFCE0F-9FB5-4685-B395-1440B******
PreferredBackupTime

string

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

07:00Z-08:00Z
BackupRetentionPolicyOnClusterDeletion

string

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

  • ALL：长期保留全部备份。

  • LATEST：长期保留最后一个备份。

  • NONE（默认）：不保留备份集。

NONE
PreferredNextBackupTime

string

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

2020-11-16T07:30Z
DataLevel2BackupRetentionPeriod

string

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

  • 0：关闭二级备份功能。

  • 30～7300：二级备份保留周期，单位为天。

  • -1：二级备份长期保留。

说明

创建集群时，默认取值为 0，即关闭二级备份功能。

0
BackupFrequency

string

备份频率，取值如下：

  • Normal（默认）：常规备份，每天定时备份一次。

  • 2/24H：增强备份，每 2 小时备份一次。

  • 3/24H：增强备份，每 3 小时备份一次。

  • 4/24H：增强备份，每 4 小时备份一次。

说明

  • 开启增强备份后，备份完成时间在 24 小时内的备份会全部保留。超过 24 小时的，系统将仅保留每日 00:00 点后完成的第一个备份，其他均被删除。

  • 开启增强备份后，备份周期 PreferredBackupPeriod 参数会默认选择一周内的所有天数（即从周一至周日）。

Normal
DataLevel1BackupFrequency

string

备份频率，取值如下：

  • Normal（默认）：常规备份，每天定时备份一次。

  • 2/24H：高频备份，每 2 小时备份一次。

  • 3/24H：高频备份，每 3 小时备份一次。

  • 4/24H：高频备份，每 4 小时备份一次。

说明

  • PolarDB PostgreSQL 版（兼容 Oracle）、PolarDB PostgreSQL 版不支持该参数。

  • 如果您的 PolarDB MySQL 版所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见概述。

Normal
DataLevel1BackupPeriod

string

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

  • Monday：周一

  • Tuesday：周二

  • Wednesday：周三

  • Thursday：周四

  • Friday：周五

  • Saturday：周六

  • Sunday：周日

说明

  • 至少需要选择 2 天，多个值之间用英文逗号（,）隔开。

  • PolarDB PostgreSQL 版（兼容 Oracle）、PolarDB PostgreSQL 版不支持该参数。

  • 如果您的 PolarDB MySQL 版所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见概述。

Monday,Tuesday
DataLevel1BackupTime

string

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

说明

  • PolarDB PostgreSQL 版（兼容 Oracle）、PolarDB PostgreSQL 版不支持该参数。

  • 如果您的 PolarDB MySQL 版所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见概述。

15:00Z-16:00Z
DataLevel2BackupPeriod

string

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

  • Monday：周一

  • Tuesday：周二

  • Wednesday：周三

  • Thursday：周四

  • Friday：周五

  • Saturday：周六

  • Sunday：周日

说明

  • 至少需要选择 2 天，多个值之间用英文逗号（,）隔开。

  • PolarDB PostgreSQL 版（兼容 Oracle）、PolarDB PostgreSQL 版不支持该参数。

  • 如果您的 PolarDB MySQL 版所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见概述。

Monday,Tuesday
DataLevel2BackupAnotherRegionRetentionPeriod

string

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

  • 0：关闭二级备份功能。

  • 30～7300：二级备份保留周期，单位为天。

  • 1：二级备份长期保留。

说明

创建集群时，默认取值为 0，即关闭二级备份跨地域备份功能。

30
DataLevel2BackupAnotherRegionRegion

string

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

cn-hangzhou
BackupPolicyLevel

string

当前备份策略等级。取值范围如下：

  • Normal：常规备份

  • Advanced：高级备份

说明

  • PolarDB PostgreSQL 版（兼容 Oracle）、PolarDB PostgreSQL 版不支持该参数。

Normal
AdvancedPolicyOption

string

高级备份策略选项。取值范围如下：

  • enable：已开启高级备份

  • disable：未开启高级备份，可选择开启

  • notSupport：不支持高级备份

说明

  • PolarDB PostgreSQL 版（兼容 Oracle）、PolarDB PostgreSQL 版不支持该参数。

disable
AdvancedDataPolicies

object

AdvancedDataPolicy

array<object>

高级备份策略详情。

说明

  • PolarDB PostgreSQL 版（兼容 Oracle）、PolarDB PostgreSQL 版不支持该参数。

object

OnlyPreserveOneEachHour

boolean

每小时备份保留策略。取值如下：

  • true：超过 1 小时只保留每小时内最早的备份集。

  • false：保留全部备份集。

true
RetentionValue

string

备份保留天数。

7
BakType

string

备份类型，返回值如下：

  • F：全量备份

F
FilterKey

string

调度类型，返回值如下：

  • dayOfWeek：按周调度

  • dayOfMonth：按月调度

  • dayOfYear：按年调度

  • backupInterval：固定间隔调度

说明

仅当 FilterType 为 crontab 时，返回该参数。

dayOfWeek
FilterValue

string

备份周期。

1,2,3,4,5,6,7
DestType

string

备份策略目标类型，取值如下：

  • level1：一级备份

  • level2：二级备份

  • level2Cross：二级跨地域备份

FilterType

string

高级策略筛选类型，返回值如下：

  • crontab：周期调度

  • event：事件调度

crontab
SrcRegion

string

备份策略源地域。

cn-beijing
AutoCreated

boolean

是否为系统自动生成的备份策略，返回值如下：

  • true：系统生成策略

  • false：用户自定义策略

true
SrcType

string

备份策略源类型，返回值如下：

  • db：数据库集群

  • level1：一级备份

  • level2：二级备份

  • level2Cross：二级跨地域备份

level1
OnlyPreserveOneEachDay

boolean

24 小时备份保留策略。

  • true：超过 24 小时仅保留当天第 1 个备份集

  • false：全保留

true
DumpAction

string

一级备份转二级备份方式，返回值如下：

  • copy：复制

copy
PolicyId

string

备份策略 ID。

71930ac2e9f15e41615e10627c******

DestRegion

string

备份策略目标地域。

cn-hangzhou
RetentionType

string

备份集保留周期类型，返回值如下：

  • never：长期保留

  • delay：固定天数保留

delay

示例

正常返回示例

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",
  "BackupPolicyLevel": "Normal",
  "AdvancedPolicyOption": "disable",
  "AdvancedDataPolicies": {
    "AdvancedDataPolicy": [
      {
        "OnlyPreserveOneEachHour": true,
        "RetentionValue": "7",
        "BakType": "F",
        "FilterKey": "dayOfWeek",
        "FilterValue": "1,2,3,4,5,6,7",
        "DestType": "",
        "FilterType": "crontab",
        "SrcRegion": "cn-beijing",
        "AutoCreated": true,
        "SrcType": "level1",
        "OnlyPreserveOneEachDay": true,
        "DumpAction": "copy",
        "PolicyId": "71930ac2e9f15e41615e10627c******\n",
        "DestRegion": "cn-hangzhou",
        "RetentionType": "delay"
      }
    ]
  }
}

错误码

HTTP status code

错误码

错误信息

描述
400 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid.
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 当前的记录中不存在提供的DBClusterId。
404 InvalidDBClusterId.NotFound The DBInstanceId provided does not exist in our records. 当前的记录中不存在提供的DBClusterId。

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

变更历史

更多信息，参考变更详情。

上一篇：备份策略下一篇：DescribeLogBackupPolicy - 查询集群日志备份保留策略