文档中心

缓存数据库 Redis 版

备份恢复

DescribeBackupPlan

调用 DescribeBackupPlan 接口查询目标 Redis 实例的自动备份策略，包括备份类型、备份周期、下一次执行备份的预期时间等信息。

请求类型

同步请求。

注意事项

仅主备实例（即 InstanceClass 为 PrimarySecondary）支持调用该接口，单节点实例（即 InstanceClass 取值为 Standalone）不支持备份恢复相关操作，不支持调用该接口。关于两种类型实例的功能特性差异详情，请参见功能特性差异。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	redis-cn0212gzmh2xs****	实例 ID。说明您可以调用 DescribeDBInstances接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。

返回参数

参数	类型	示例值	描述
Active	Boolean	true	是否启用自动备份，取值范围如下： true：已启用。 false：未启用。
BackupHour	Integer	5	开始执行备份的时间段（UTC+8）。取值范围为 0 到 23 间的任意整数，其中 0 表示系统会在 00:00~00:59 时段内执行备份，1 表示会在 01:00~01:59 时段内执行备份，以此类推。
BackupType	String	Full	恢复方式。取值范围如下： Full：全量恢复，即按备份集恢复。 Inc：增量恢复，即按时间点恢复。
ExpectNextBackupTime	String	2024-07-10T20:20:20Z	下一次执行备份的预期时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC）。
InstanceId	String	redis-cn0212gzmh2xs****	实例 ID。
LastUpdateTime	String	2024-07-10T00:00:00Z	上一次修改备份策略的时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC）。
Period	Array of Integer	[1,2,3,4,5,6,7]	备份周期。取值范围为 1 到 7 之间的任意整数。其中，1 表示每周一进行备份，2 表示每周二进行备份，以此类推。
TTL	Integer	7	备份文件的保留天数，默认为 7 天。

示例

请求示例

返回示例

错误码

更多详情，请参见错误码。

最近更新时间：2026.09.21 14:23:30

这个页面对您有帮助吗？

有用

无用