DescribeBackupPolicy
该接口用于查询RDS实例的备份设置
服务地址:
华东1 金融云
输入参数
只看必填
DBInstanceId实例ID
BackupPolicyMode备份类型
CompressType备份压缩方式
ReleasedKeepPolicyMySQL已删除实例的归档备份保留策略
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

适用引擎

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

请求参数

字段名称字段详情
DBInstanceIdstring

实例 ID。可调用 DescribeDBInstances 获取。

示例值:rm-uf6wjk5****参考取值来源:
    CloneDBInstance
    CreateDBInstance
    ReceiveDBInstance
    ModifyDBInstanceSpec
    RecoveryDBInstance
    DescribeDBInstances
    CalculateDBInstanceWeight
    MigrateDBNodes
    UpgradeDBInstanceMajorVersion
    TransformDBInstancePayType
    EvaluateLocalExtendDisk
    RestoreDdrTable
    RebuildReplicationLink
BackupPolicyModestring

备份类型,取值:展开详情

示例值:DataBackupPolicy
CompressTypestring

备份压缩方式,取值:展开详情

示例值:1
ReleasedKeepPolicystring

MySQL 已删除实例的归档备份保留策略。取值:展开详情

示例值:Lastest

返回参数

字段名称字段详情
ArchiveBackupKeepCountstring

MySQL 实例归档备份的保留个数。

示例值:1
ArchiveBackupKeepPolicystring

MySQL 实例归档备份的保留周期。

示例值:ByMonth
ArchiveBackupRetentionPeriodstring

MySQL 实例归档备份的保留天数。

示例值:365
BackupIntervalstring

备份间隔,单位:分钟。展开详情

示例值:30
BackupLogstring

是否已开启日志备份。返回值:展开详情

示例值:Enable
BackupMethodstring

SQL Server 云盘版实例的备份方式。返回值:展开详情

示例值:Physical
BackupPriorityinteger<int32>

SQL Server 企业集群版实例备库备份的设置。返回值:展开详情

示例值:2
BackupRetentionPeriodinteger<int32>

数据备份保留天数。

示例值:7
Categorystring

MySQLPostgreSQL 实例是否已开启秒级备份。返回值:展开详情

示例值:Standard
CompressTypestring

备份压缩方式。返回值:展开详情

示例值:1
EnableBackupLogstring

是否开启了日志备份。返回值:展开详情

示例值:1
EnableIncrementDataBackupboolean

SQL Server实例是否已开启增量备份。返回值:展开详情

示例值:True
EnablePitrProtectionboolean

MySQL 实例是否已开启 PITR 任意时间点恢复(原日志备份的升级版)。返回值:展开详情

示例值:True
HighSpaceUsageProtectionstring

MySQL 实例使用空间大于 80%,或者剩余空间小于 5 GB 时,是否强制清理 Binlog。返回值:展开详情

示例值:Enable
LocalLogRetentionHoursinteger<int32>

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

示例值:0
LocalLogRetentionSpacestring

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

示例值:30
LogBackupFrequencystring

SQL Server实例的日志备份频率。返回值:展开详情

示例值:LogInterval
LogBackupLocalRetentionNumberinteger<int32>

MySQL 实例本地 Binlog 保留个数。

示例值:60
LogBackupRetentionPeriodinteger<int32>

日志备份保留天数。

示例值:7
PitrRetentionPeriodinteger<int32>

MySQL 实例的可任意时间点恢复天数。

示例值:7
PreferredBackupPeriodstring

数据备份周期,多个取值用英文逗号(,)隔开。返回值:展开详情

示例值:Monday,Wednesday,Friday,Sunday
PreferredBackupTimestring

数据备份时间,格式:HH:mmZ-HH:mmZ(UTC 时间)。

示例值:15:00Z-16:00Z
PreferredNextBackupTimestring

下次备份时间。格式:yyyy-MM-ddTHH:mmZ(UTC 时间)。

示例值:2018-01-19T15:15Z
ReleasedKeepPolicystring

MySQL 已删除实例的归档备份保留策略。返回值:展开详情

示例值:None
RequestIdstring

请求 ID。

示例值:B87E2AB3-B7C9-4394-9160-7F639F732031
SupportModifyBackupPriorityboolean

SQL Server实例是否支持修改备库备份选项。返回值:展开详情

示例值:False
SupportReleasedKeepinteger<int32>

备用参数。

示例值:0
SupportVolumeShadowCopyinteger<int32>

SQL Server实例是否支持快照备份。返回值:展开详情

示例值:1
SupportsHighFrequencyBackupinteger<int64>

SQL Server实例是否支持 5 分钟日志备份功能。返回值:展开详情

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:0
变更历史
变更时间变更内容概要操作
2024-08-29
变更返回参数
2024-01-31
变更返回参数
2023-06-29
变更返回参数
2022-11-15
变更错误码400
新增错误码403
变更错误码404
2022-08-31
变更返回参数