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:DescribeBackupPolicyRead
  • dbcluster
    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}
    无
无

请求参数

名称类型必填描述示例值
DBClusterIdstring是

集群 ID。

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

返回参数

名称类型描述示例值
object
PreferredBackupPeriodstring

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

  • Monday：周一
  • Tuesday：周二
  • Wednesday：周三
  • Thursday：周四
  • Friday：周五
  • Saturday：周六
  • Sunday：周日
Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday
DataLevel1BackupRetentionPeriodstring

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

7
RequestIdstring

请求 ID。

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

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

07:00Z-08:00Z
BackupRetentionPolicyOnClusterDeletionstring

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

  • ALL：长期保留全部备份。
  • LATEST：长期保留最后一个备份。
  • NONE（默认）：不保留备份集。
NONE
PreferredNextBackupTimestring

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

2020-11-16T07:30Z
DataLevel2BackupRetentionPeriodstring

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

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

备份频率，取值如下：

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

    备份频率，取值如下：

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

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

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

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

    说明
  • PolarDB PostgreSQL 版（兼容 Oracle）、PolarDB PostgreSQL 版不支持该参数。
  • 如果您的 PolarDB MySQL 版所在的地域不支持跨地域备份功能，将不支持该参数。跨地域备份支持的地域请参见概述。
    •
    		15:00Z-16:00Z
    DataLevel2BackupPeriodstring

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

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

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

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

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

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

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

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

    		cn-hangzhou

    示例

    正常返回示例

    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"
}

    错误码

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

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

    变更历史

    变更时间变更内容概要操作
    2023-09-12OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更。
      错误码 404 变更
      删除错误码：400
    2022-06-01OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更。
      删除错误码：404
    出参OpenAPI 返回结构发生变更。
    2021-03-02OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更。
      删除错误码：404
    出参OpenAPI 返回结构发生变更。
    上一篇：备份策略下一篇：DescribeLogBackupPolicy - 查询集群日志备份保留策略
    文档推荐