接口说明
适用引擎
- 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 |
PreferredBackupTimestring | 执行备份任务的时间。格式：HH:mmZ-HH:mmZ（UTC 时间）。展开详情 示例值:00:00Z-01:00Z |
PreferredBackupPeriodstring | 备份周期。至少需要指定 2 天，多个取值用英文逗号（,）隔开。取值：展开详情 示例值:Monday |
BackupRetentionPeriodstring | 数据备份保留天数，取值：7~730。展开详情 示例值:7 |
BackupLogstring | 是否开启日志备份。取值：展开详情 示例值:Enable参考取值来源: DescribeBackupPolicy |
LogBackupRetentionPeriodstring | 日志备份保留天数。取值：7~730，且不大于数据备份保留天数。展开详情 示例值:7 |
EnableBackupLogstring | MySQL、PostgreSQL、MariaDB 实例是否开启日志备份。取值：展开详情 示例值:1枚举值:10TrueFalse参考取值来源: DescribeBackupPolicy |
LocalLogRetentionHoursstring | MySQL 实例日志备份本地保留小时数。取值：0~7*24，0 表示不保留。展开详情 示例值:18 |
LocalLogRetentionSpacestring | MySQL 实例本地日志最大循环空间使用率，超出后，则从最早的 Binlog 开始清理，直到空间使用率低于该比例。取值：0~50。默认不修改。展开详情 示例值:30 |
HighSpaceUsageProtectionstring | MySQL 实例使用空间大于 80%，或者剩余空间小于 5 GB 时，是否无条件清理 Binlog。取值：Enable | Disable。默认不修改。展开详情 示例值:Enable |
LogBackupFrequencystring | SQL Server实例的日志备份频率，取值：展开详情 示例值:LogInterval参考取值来源: DescribeBackupPolicy |
CompressTypestring | 备份压缩方式。取值：展开详情 示例值:4 |
ArchiveBackupRetentionPeriodstring | 归档备份的保留天数。默认为 0，表示未开启归档备份。取值：30~1095。展开详情 示例值:365 |
ArchiveBackupKeepPolicystring | 归档备份的保留周期，该周期内能保存的备份个数由 ArchiveBackupKeepCount 决定。默认为 0。取值：展开详情 示例值:ByMonth参考取值来源: DescribeBackupPolicy |
ArchiveBackupKeepCountinteger<int32> | 归档备份的保留个数。默认为 1。取值：展开详情 示例值:1 |
ReleasedKeepPolicystring | MySQL 已删除实例的归档备份保留策略。取值：展开详情 示例值:None参考取值来源: DescribeBackupPolicy |
LogBackupLocalRetentionNumberinteger<int32> | 本地 Binlog 保留个数。默认为 60。取值：6~100。展开详情 示例值:60 |
Categorystring | 是否开启秒级备份。取值：展开详情 示例值:Standard |
BackupIntervalstring | 快照备份频率。取值：展开详情 示例值:30参考取值来源: DescribeBackupPolicy |
BackupMethodstring | SQL Server 云盘版实例的备份方式。取值：展开详情 示例值:Physical参考取值来源: DescribeDetachedBackups |
EnableIncrementDataBackupboolean | SQL Server 云盘版实例是否开启增量备份。取值：展开详情 示例值:False |
BackupPriorityinteger<int32> |
返回参数
| 字段名称 | 字段详情 |
|---|---|
CompressTypestring | 备份压缩方式，取值：展开详情 示例值:4 |
DBInstanceIDstring | 实例 ID。 示例值:rm-uf6wjk5**** |
EnableBackupLogstring | 是否开启日志备份。取值：展开详情 示例值:1 |
HighSpaceUsageProtectionstring | MySQL 实例使用空间大于 80%，或者剩余空间小于 5 GB 时，是否无条件清理 Binlog。 示例值:Disable |
LocalLogRetentionHoursinteger<int32> | MySQL 实例日志备份本地保留小时数。 示例值:18 |
LocalLogRetentionSpacestring | MySQL 实例本地日志最大循环空间使用率。 示例值:30 |
LogBackupLocalRetentionNumberinteger<int32> | MySQL 实例本地 Binlog 保留个数。 示例值:60 |
RequestIdstring | 请求 ID。 示例值:DA147739-AEAD-4417-9089-65E9B1D8240D |
返回示例
错误返回示例
变更历史
| 变更时间 | 变更内容概要 | 操作 | |
|---|---|---|---|
| 2025-03-31 | |||
| 2024-06-03 | |||
| 2023-06-29 | |||
| 2022-08-31 | |||
| 2022-05-10 |