首页 云数据库 RDS 开发参考 API参考 API目录 备份 DescribeBackupPolicy - 查看实例备份设置

DescribeBackupPolicy - 查看实例备份设置

更新时间: 2023-09-20 11:27:33

该接口用于查询RDS实例的备份设置。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server
  • RDS MariaDB

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:DescribeBackupPolicyREAD
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag
无

请求参数

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

实例ID。可调用DescribeDBInstances获取。

rm-uf6wjk5****
BackupPolicyModestring否

备份类型，取值：

  • DataBackupPolicy：数据备份
  • LogBackupPolicy：日志备份
DataBackupPolicy
CompressTypestring否

备份压缩方式，取值：

  • 0：不压缩
  • 1：zlib压缩
  • 2：并行zlib压缩
  • 4：quicklz压缩，开启了库表恢复
  • 8：MySQL8.0 quicklz压缩但是还未支持库表恢复
1
ReleasedKeepPolicystring否

已删除实例的归档备份保留策略。取值：

  • None：不保留
  • Lastest：保留最后一个
  • All：全部保留
Lastest

返回参数

名称类型描述示例值
object

返回参数详情。

LogBackupRetentionPeriodinteger

日志备份保留天数。

7
ArchiveBackupKeepPolicystring

归档备份的保留周期。

ByMonth
ArchiveBackupKeepCountstring

归档备份的保留个数。

1
LocalLogRetentionHoursinteger

本地日志备份保留小时数。

0
BackupRetentionPeriodinteger

数据备份保留天数。

7
RequestIdstring

请求ID。

B87E2AB3-B7C9-4394-9160-7F639F732031
PreferredBackupPeriodstring

数据备份周期，多个取值用英文逗号（,）隔开。返回值：

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

备份压缩方式。返回值：

  • 0：不压缩
  • 1：zlib压缩
  • 2：并行zlib压缩
  • 4：quicklz压缩，开启了库表恢复
  • 8：MySQL8.0 quicklz压缩但是还未支持库表恢复
1
SupportReleasedKeepinteger

备用参数。

0
LocalLogRetentionSpacestring

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

30
SupportVolumeShadowCopyinteger

实例是否支持快照备份。返回值：

  • 1：是
  • 0：否
说明 仅SQL Server实例会返回此参数。
1
BackupMethodstring

实例的备份方式。返回值：

  • Physical：物理备份
  • Snapshot：快照备份
说明 仅SQL Server云盘版实例会返回本参数。
Physical
LogBackupFrequencystring

日志备份频率。返回值：

  • LogInterval：每30分钟备份一次；
  • 默认与数据备份周期PreferredBackupPeriod一致。
说明 参数LogBackupFrequency仅适用于SQL Server。
LogInterval
PreferredNextBackupTimestring

下次备份时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。

2018-01-19T15:15Z
HighSpaceUsageProtectionstring

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

  • Disable：不清理
  • Enable：清理
Enable
ArchiveBackupRetentionPeriodstring

归档备份的保留天数。

365
BackupIntervalstring

备份间隔，单位：分钟。

  • 对于MySQL实例是指快照备份频率（非快照备份周期）。
  • 对于SQL Server实例是指日志备份频率。
30
ReleasedKeepPolicystring

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

  • None：不保留
  • Lastest：保留最后一个
  • All：全部保留
None
PreferredBackupTimestring

数据备份时间，格式：HH:mmZ-HH:mmZ（UTC时间）。

15:00Z-16:00Z
LogBackupLocalRetentionNumberinteger

本地Binlog保留个数。

60
Categorystring

是否开启秒级备份。返回值：

  • Flash：开启
  • Standard：关闭
说明 仅在BackupPolicyMode参数为DataBackupPolicy时生效。
Standard
EnableBackupLogstring

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

  • 1：开启
  • 0：关闭
1
BackupLogstring

是否已开启日志备份。返回值：

  • Enable：是
  • Disabled：否
Enable
EnableIncrementDataBackupboolean

是否已开启增量备份。返回值：

  • True：是
  • False：否
True
SupportModifyBackupPriorityboolean

是否支持修改备库备份选项。返回值：

  • True：是
  • False：否
False
BackupPriorityinteger

备库备份的设置。返回值：

  • 1：优先备库
  • 2：强制主库
说明 该参数仅适用于SQL Server集群版实例，仅当SupportModifyBackupPriority为True时返回该参数。
2

示例

正常返回示例

JSON格式

{
  "LogBackupRetentionPeriod": 7,
  "ArchiveBackupKeepPolicy": "ByMonth",
  "ArchiveBackupKeepCount": "1",
  "LocalLogRetentionHours": 0,
  "BackupRetentionPeriod": 7,
  "RequestId": "B87E2AB3-B7C9-4394-9160-7F639F732031",
  "PreferredBackupPeriod": "Monday,Wednesday,Friday,Sunday",
  "CompressType": "1",
  "SupportReleasedKeep": 0,
  "LocalLogRetentionSpace": "30",
  "SupportVolumeShadowCopy": 1,
  "BackupMethod": "Physical",
  "LogBackupFrequency": "LogInterval",
  "PreferredNextBackupTime": "2018-01-19T15:15Z",
  "HighSpaceUsageProtection": "Enable",
  "ArchiveBackupRetentionPeriod": "365",
  "BackupInterval": "30",
  "ReleasedKeepPolicy": "None",
  "PreferredBackupTime": "15:00Z-16:00Z",
  "LogBackupLocalRetentionNumber": 60,
  "Category": "Standard",
  "EnableBackupLog": "1",
  "BackupLog": "Enable",
  "EnableIncrementDataBackup": true,
  "SupportModifyBackupPriority": true,
  "BackupPriority": 2
}

错误码

HTTP status code错误码错误信息描述
400IO.ExceptionIO exception, retry later.io异常。
400InternalFailureInternal failure, retry later.请求失败，请稍后重试。
400InvalidParameter.OwnerAccountThe specified parameter OwnerAccount is not valid.操作失败，参数OwnerAccount不合法，请检查。
400InvalidEngine.MalformedSpecified engine is not valid.当前数据库引擎无效，请选择正确的数据库引擎。
403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.当前实例状态不支持此操作。
404InvalidDBInstance.NotFoundSpecified instance does not exist or not support.指定的实例不存在指定的实例被删除或者实例不支持当前操作。
404InvalidDBInstanceName.NotFoundInvalid DBInstanceId NotFound.数据库实例ID不存在，请检查。

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

变更历史

变更时间变更内容概要操作
2023-06-29OpenAPI 错误码发生变更，OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码：400
    删除错误码：403
    删除错误码：404
出参OpenAPI 返回结构发生变更
2022-06-24OpenAPI 描述信息更新，OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码：400
    删除错误码：404
阿里云首页 云数据库 RDS 相关技术圈