文档

DescribeBackupPolicy - 查询备份策略

更新时间:

查询PolarDB实例备份策略。

接口说明

适用引擎

PolarDB MySQL 版

说明 当前该接口仅针对特定客户开放使用,如有需求,请到 DBS 客户咨询群(钉钉群号:35585947)申请使用。

相关功能文档

PolarDB MySQL 版备份策略

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionCodestring

备份集所在地域。

cn-beijing
InstanceNamestring

PolarDB 实例 ID。

pc-2ze3nrr64c5****

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求 ID。

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

返回信息。

instanceName can not be empty.
Dataobject

备份策略详情。

PreferredBackupDatestring

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

1010101
PreferredBackupWindowBeginstring

基础备份窗口开始时间。

23:00Z
PreferredBackupWindowstring

基础备份窗口。

23:00Z-24:00Z
BackupRetentionPeriodinteger

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

7
BackupRetentionPolicyOnClusterDeletionstring

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

  • NONE:不保留
  • LATEST:保留最后一个
  • ALL:全部保留
LATEST
HighFrequencyBakIntervalinteger

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

120
BackupPriorityinteger

备库备份的设置策略,返回值如下:

  • 1:优先备库
  • 2:强制主库
说明 该参数仅适用于 RDS SQL Server 实例,其他引擎返回值为 0
0
EnableLogBackupinteger

是否开启日志备份,返回值如下:

  • 1:开启
  • 0:未开启
1
LogBackupRetentioninteger

日志备份保留周期。

7
LogBackupLocalRetentionNumberstring

本地日志文件保留个数。

10
EnableBackupinteger

是否开启备份。

1
LocalLogRetentionSpaceinteger

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

30
HighSpaceUsageProtectionstring

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

  • Disable:不清理
  • Enable:清理
Enable
Categorystring

是否开启秒级备份,返回值如下:

  • Flash:已开启秒级备份
  • Standard:普通备份
说明 该参数仅对 MySQL 生效。
Standard
IncBackupIntervalinteger

高频增量备份间隔。

-1
EnableIncBackupinteger

是否开启增量备份。

0
BackupMethodstring

备份方式,返回值如下:

  • Physical:物理备份
  • Snapshot:快照备份
Physical
AdvanceLogPoliciesobject []

日志备份策略详情。

PolicyIdstring

备份策略 ID。

dc13b153acc91141789122c23835****
SrcTypestring

备份策略源类型,返回值如下:

  • db:数据库
  • level1:一级备份
  • level2:二级备份
  • level2Cross:二级跨地域备份
level1
SrcRegionstring

备份策略源地域。

cn-beijing
DestTypestring

备份策略目标类型,返回值如下:

  • db:数据库
  • level1:一级备份
  • level2:二级备份
  • level2Cross:二级跨地域备份
level1
DestRegionstring

备份策略目标地域。

cn-shanghai
EnableLogBackupboolean

预留参数,无需关注。

1
LogRetentionTypestring

日志备份保留类型,返回值如下:

  • never:永不过期
  • delay:固定天数过期
delay
LogRetentionValuestring

日志备份保留时间。

3
AdvanceDataPoliciesobject []

数据备份策略详情。

PolicyIdstring

高级策略 ID。

71930ac2e9f15e41615e10627c******
FilterTypestring

高级策略筛选类型,返回值如下:

  • crontab:周期调度
  • event:事件调度
crontab
FilterKeystring

调度类型,返回值如下:

  • dayOfWeek:按周调度
  • dayOfMonth:按月调度
  • dayOfYear:按年调度
  • backupInterval:固定间隔调度
说明 仅当 FilterType 为 crontab 时,返回该参数。
dayOfWeek
FilterValuestring

备份周期。

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

转储策略详情,返回值如下:

  • copy:复制
  • move:转储
copy
RetentionTypestring

备份集保留周期类型,返回值如下:

  • never:永不过期
  • delay:固定天数过期
delay
RetentionValuestring

过期天数。

7
SrcTypestring

备份策略源类型,返回值如下:

  • db:数据库
  • level1:一级备份
  • level2:二级备份
  • level2Cross:二级跨地域备份
db
SrcRegionstring

备份策略源地域。

cn-beijing
DestTypestring

备份策略目标类型,返回值如下:

  • db:数据库
  • level1:一级备份
  • level2:二级备份
  • level2Cross:二级跨地域备份
level1
DestRegionstring

备份策略目标地域。

cn-beijing
BakTypestring

备份类型,返回值如下:

  • F:全量备份
  • L:日志备份
F
AutoCreatedboolean

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

  • true:系统生成策略
  • false:用户自定义策略
true
ErrMessagestring

错误信息。

The specified parameter %s value is not valid.
Codestring

状态码。

Success
Successstring

请求是否成功,返回值如下:

  • true:请求成功
  • false:请求失败
true
ErrCodestring

错误码。

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": true,
        "LogRetentionType": "delay",
        "LogRetentionValue": "3"
      }
    ],
    "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
      }
    ]
  },
  "ErrMessage": "The specified parameter %s value is not valid.     ",
  "Code": "Success",
  "Success": "true",
  "ErrCode": "Success"
}

错误码

HTTP status code错误码错误信息描述
403Request.ForbiddenHave no Permissions当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作

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

变更历史

变更时间变更内容概要操作
2024-05-28OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2024-05-17OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)