AI 助理
文档备案控制台
官方文档
输入文档关键字查找
首页

DescribeBackupPolicy - 查询备份策略

更新时间：
复制为 MD 格式
产品详情
我的收藏

查询PolarDB实例备份策略。

接口说明

适用引擎

PolarDB MySQL 版

说明

当前该接口仅针对特定客户开放使用，如有需求，请到 DBS 客户咨询群（钉钉群号：35585947）申请使用。

相关功能文档

PolarDB MySQL 版备份策略

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dbs:DescribeBackupPolicy

get

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
RegionCode

string

否

备份集所在地域。

cn-beijing
InstanceName

string

否

PolarDB 实例 ID。

pc-2ze3nrr64c5****

返回参数

名称

类型

描述

示例值

object

返回参数详情。

RequestId

string

请求 ID。

54A63B3B-AA10-1CC3-A6BB-6CCE98D19628
Message

string

返回信息。

instanceName can not be empty.
Data

object

备份策略详情。

PreferredBackupDate

string

基础备份的备份周期，以一个 7 位数返回，从左到右每一位分别对应周一到周日，其中 1 代表备份，0 代表不进行备份。

1010101
PreferredBackupWindowBegin

string

基础备份窗口开始时间。

23:00Z
PreferredBackupWindow

string

基础备份窗口。

23:00Z-24:00Z
BackupRetentionPeriod

integer

基础备份保留时间，若开启高级备份策略，则为一级备份策略中的最长保留时间。

7
BackupRetentionPolicyOnClusterDeletion

string

已删除实例的归档备份保留策略，返回值如下：

  • NONE：不保留

  • LATEST：保留最后一个

  • ALL：全部保留

LATEST
HighFrequencyBakInterval

integer

高频备份时间。例如 120 表示每两小时备份一次，单位为分钟。

120
BackupPriority

integer

备库备份的设置策略，返回值如下：

  • 1：优先备库

  • 2：强制主库

说明

该参数仅适用于 RDS SQL Server 实例，其他引擎返回值为 0。

0
EnableLogBackup

integer

是否开启日志备份，返回值如下：

  • 1：开启

  • 0：未开启

1
LogBackupRetention

integer

日志备份保留周期。

7
LogBackupLocalRetentionNumber

string

本地日志文件保留个数。

10
EnableBackup

integer

是否开启备份。

1
LocalLogRetentionSpace

integer

本地日志最大空间使用率。

30
HighSpaceUsageProtection

string

实例使用空间大于 80%，或者剩余空间小于 5 GB 时，是否强制清理日志：

  • Disable：不清理

  • Enable：清理

Enable
Category

string

是否开启秒级备份，返回值如下：

  • Flash：已开启秒级备份

  • Standard：普通备份

说明

该参数仅对 MySQL 生效。

Standard
IncBackupInterval

integer

高频增量备份间隔。

-1
EnableIncBackup

integer

是否开启增量备份。

0
BackupMethod

string

备份方式，返回值如下：

  • Physical：物理备份

  • Snapshot：快照备份

Physical
AdvanceLogPolicies

array<object>

日志备份策略详情。

object

策略详情。

PolicyId

string

备份策略 ID。

dc13b153acc91141789122c23835****
SrcType

string

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

  • db：数据库

  • level1：一级备份

  • level2：二级备份

  • level2Cross：二级跨地域备份

level1
SrcRegion

string

备份策略源地域。

cn-beijing
DestType

string

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

  • db：数据库

  • level1：一级备份

  • level2：二级备份

  • level2Cross：二级跨地域备份

level1
DestRegion

string

备份策略目标地域。

cn-shanghai
EnableLogBackup

integer

预留参数，无需关注。

1
LogRetentionType

string

日志备份保留类型，返回值如下：

  • never：永不过期

  • delay：固定天数过期

delay
LogRetentionValue

string

日志备份保留时间。

3
FilterType

string

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

crontab：周期调度

event：事件调度

crontab
FilterKey

string

调度类型，返回值如下：

dayOfWeek：按周调度

dayOfMonth：按月调度

dayOfYear：按年调度

backupInterval：固定间隔调度

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

dayOfWeek
FilterValue

string

备份周期。

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

array<object>

数据备份策略详情。

object

策略详情。

PolicyId

string

高级策略 ID。

71930ac2e9f15e41615e10627c******
FilterType

string

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

  • crontab：周期调度

  • event：事件调度

crontab
FilterKey

string

调度类型，返回值如下：

  • dayOfWeek：按周调度

  • dayOfMonth：按月调度

  • dayOfYear：按年调度

  • backupInterval：固定间隔调度

说明

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

dayOfWeek
FilterValue

string

备份周期。

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

string

转储策略详情，返回值如下：

  • copy：复制

  • move：转储

copy
RetentionType

string

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

  • never：永不过期

  • delay：固定天数过期

delay
RetentionValue

string

过期天数。

7
SrcType

string

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

  • db：数据库

  • level1：一级备份

  • level2：二级备份

  • level2Cross：二级跨地域备份

db
SrcRegion

string

备份策略源地域。

cn-beijing
DestType

string

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

  • db：数据库

  • level1：一级备份

  • level2：二级备份

  • level2Cross：二级跨地域备份

level1
DestRegion

string

备份策略目标地域。

cn-beijing
BakType

string

备份类型，返回值如下：

  • F：全量备份

  • L：日志备份

F
AutoCreated

boolean

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

  • true：系统生成策略

  • false：用户自定义策略

true
StorageClass

string

数据存储类型。

STANDARD
AdvanceIncPolicies

array<object>

高级策略筛选类型 Crontab - 周期调度 Event - 事件调度

object

PolicyId

string

高级策略 ID

smp-l0bfdmlr4c***
FilterType

string

高级策略筛选类型 Crontab - 周期调度 Event - 事件调度

crontab
FilterKey

string

调度类型，当前仅当 filterType 为 crontab 时有效 dayOfWeek - 按周调度 dayOfMonth - 按月调度 dayOfYear - 按年调度 backupInterval - 固定间隔调度

dayOfMonth
FilterValue

string

具体 Filter 的值

1
DumpAction

string

转储策略 Copy - 复制 Move - 转储

Copy
RetentionType

string

保留周期类型 Never - 永不过期 Delay - 固定天数过期

delay
RetentionValue

string

过期天数

365
SrcType

string

备份策略源类型 db - 数据库 level1 - 一级备份 level2 - 二级备份 level2Cross - 二级跨地域备份

db
SrcRegion

string

备份策略源 region

cn-hangzhou
DestType

string

备份策略目标类型 db - 数据库 level1 - 一级备份 level2 - 二级备份 level2Cross - 二级跨地域备份

db
DestRegion

string

备份策略目标 region

cn-hangzhou
BakType

string

备份类型 F - 全量 L 日志

F
AutoCreated

boolean

是否系统自动生成

true
ErrMessage

string

错误信息。

The specified parameter %s value is not valid.

Code

string

状态码。

Success
Success

string

请求是否成功，返回值如下：

  • true：请求成功

  • false：请求失败

true
ErrCode

string

错误码。

Success

示例

正常返回示例

JSON格式

{
  "RequestId": "54A63B3B-AA10-1CC3-A6BB-6CCE98D19628",
  "Message": "instanceName can not be empty.",
  "Data": {
    "PreferredBackupDate": "1010101",
    "PreferredBackupWindowBegin": "23:00Z",
    "PreferredBackupWindow": "23:00Z-24:00Z",
    "BackupRetentionPeriod": 7,
    "BackupRetentionPolicyOnClusterDeletion": "LATEST",
    "HighFrequencyBakInterval": 120,
    "BackupPriority": 0,
    "EnableLogBackup": 1,
    "LogBackupRetention": 7,
    "LogBackupLocalRetentionNumber": "10",
    "EnableBackup": 1,
    "LocalLogRetentionSpace": 30,
    "HighSpaceUsageProtection": "Enable",
    "Category": "Standard",
    "IncBackupInterval": -1,
    "EnableIncBackup": 0,
    "BackupMethod": "Physical",
    "AdvanceLogPolicies": [
      {
        "PolicyId": "dc13b153acc91141789122c23835****",
        "SrcType": "level1",
        "SrcRegion": "cn-beijing",
        "DestType": "level1",
        "DestRegion": "cn-shanghai",
        "EnableLogBackup": 1,
        "LogRetentionType": "delay",
        "LogRetentionValue": "3",
        "FilterType": "crontab",
        "FilterKey": "dayOfWeek",
        "FilterValue": "1,2,3,4,5,6,7"
      }
    ],
    "AdvanceDataPolicies": [
      {
        "PolicyId": "71930ac2e9f15e41615e10627c******",
        "FilterType": "crontab",
        "FilterKey": "dayOfWeek",
        "FilterValue": "1,2,3,4,5,6,7",
        "DumpAction": "copy",
        "RetentionType": "delay",
        "RetentionValue": "7",
        "SrcType": "db",
        "SrcRegion": "cn-beijing",
        "DestType": "level1",
        "DestRegion": "cn-beijing",
        "BakType": "F",
        "AutoCreated": true,
        "StorageClass": "STANDARD"
      }
    ],
    "AdvanceIncPolicies": [
      {
        "PolicyId": "smp-l0bfdmlr4c***",
        "FilterType": "crontab",
        "FilterKey": "dayOfMonth",
        "FilterValue": "1",
        "DumpAction": "Copy",
        "RetentionType": "delay",
        "RetentionValue": "365",
        "SrcType": "db",
        "SrcRegion": "cn-hangzhou",
        "DestType": "db",
        "DestRegion": "cn-hangzhou",
        "BakType": "F",
        "AutoCreated": true
      }
    ]
  },
  "ErrMessage": "The specified parameter %s value is not valid.     ",
  "Code": "Success",
  "Success": "true",
  "ErrCode": "Success"
}

错误码

HTTP status code

错误码

错误信息

描述
403 Request.Forbidden Have no Permissions 当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作

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

变更历史

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

上一篇：ChangeResourceGroup - DBS资源转组API下一篇：ModifyBackupPolicy - 修改备份策略