文档中心

缓存数据库 Redis 版

备份恢复

DescribeCrossRegionBackups

DescribeCrossRegionBackups

调用 DescribeCrossRegionBackups 接口查询跨地域备份文件列表。

请求类型

同步请求。

调试

API Explorer

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

请求参数

参数	类型	是否必选	示例值	描述
Scope	String	否	AccountInstances	备份查询范围。取值范围如下： OneInstance（默认值）：查询单个实例内的备份。 AccountInstances：查询当前账号下的备份。
InstanceId	String	否	redis-cn0212gzmh2xs1111	实例 ID。精确查询。说明当备份查询范围为单个实例（即 Scope 取值为OneInstance）时，该参数必填。您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。若该参数留空，表示不使用实例 ID 条件进行筛选。
Status	String	否	Available	备份状态。取值范围如下： Creating：创建中。 Available：可用。 Unavailable：不可用。 Deleting：删除中。说明更多关于备份状态的说明，请参见备份状态。
StartTime	String	否	2024-08-22T07:51:09Z	查询开始时间。格式为 yyyy-MM-ddTHH:mm:ssZ（UTC）。说明若设置了该参数，查询结束时间（即EndTime）参数也必填。若该参数留空，表示不使用时间范围筛选。
EndTime	String	否	2024-08-22T07:51:12Z	查询结束时间。格式为 yyyy-MM-ddTHH:mm:ssZ（UTC）。说明若设置了查询开始时间（即 StartTime），该参数必填。查询结束时间需晚于开始时间。若该参数留空，表示不使用时间范围筛选。
BackupStrategyList	Array of String	否	[ "AutomatedBackup", "ManualBackup" ]	备份方式列表。取值范围如下： ManualBackup：手动备份。 AutomatedBackup：自动备份。说明支持同时以数组形式传入多个备份方式。若该参数留空，表示不使用备份方式筛选。
BackupPointName	String	否	testbackup	备份时间点当时的备份名称，支持模糊查询。说明当备份查询范围为单个实例（即 Scope 取值为 OneInstance）时，该参数不生效。若该参数留空，表示不使用备份名称筛选。
BackupPointId	String	否	b-cn02xmmrp751i9cdzcphjmk4****	备份时间点当时的备份 ID。支持模糊查询。说明仅当查询范围为当前账号（即 Scope 取值为 AccountInstances）时，该参数生效。若该参数留空，表示不使用备份 ID 筛选。
ProjectName	String	否	default	备份时间点当时所属的项目。说明仅当查询范围为当前账号（即 Scope 取值为 AccountInstances）时，该参数生效。若该参数留空，表示不使用项目名称筛选。
PageSize	Integer	否	10	每页记录数。取值为 1~100 间的整数。说明若设置了页码（即 PageNumber），该参数必填。若该参数留空，表示不使用每页记录数筛选。
PageNumber	Integer	否	1	备份集信息列表的页码，取值为不超过 Integer 数据类型的最大值，起始值为 1。说明若设置了该参数，每页记录数（即 PageSize）也必填。若该参数留空，表示不使用页码范围筛选。

返回参数

参数	类型	示例值	描述
Total	Integer	1	符合查询条件的跨地域备份文件总数。
Backups	Array of BackupInfo		跨地域备份文件详情。

BackupInfo

参数	类型	示例值	描述
BackupPointId	String	b-cn02xmmrp751i9cdzcphjmk4****	备份 ID。
BackupPointName	String	testbackup	备份名称。
BackupProgress	Integer	100	当前备份的完成进度。单位为百分比。
BackupStrategy	String	ManualBackup	备份方式，取值范围如下： ManualBackup：手动备份。 AutomatedBackup：自动备份。
BackupType	String	Full	备份类型。当前仅支持 Full，即全量备份。
StartTime	String	2024-08-22T07:51:09Z	备份开始时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC）。
EndTime	String	2024-08-22T07:51:12Z	备份结束时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC）。
InstanceId	String	redis-cn0212gzmh2xs****	实例 ID。
InstanceInfo	Object of DBInstance		实例信息列表。说明若在备份文件生成后，实例修改了部分配置（如修改计费类型、续费实例、升级实例规格等），实例的最新信息可能会与备份文件中的实例信息不一致。
ProjectName	String	default	备份文件的所属项目。
Size	Long	486040	备份大小。单位：MiB。
Status	String	Available	备份状态。取值范围如下： Creating：备份创建中。 Available：备份可用。 Unavailable：备份不可用。 Deleting：备份删除中。说明关于备份状态的更多说明，请参见备份状态。
TTL	Integer	7	备份保留天数，默认保留 7 天。
SourceRegion	String	cn-beijing	备份文件的原地域。
TargetRegion	String	cn-shanghai	备份点当时的跨地域备份策略中所设的目的地域。

DBInstance

参数	类型	示例值	描述
AccountId	Long	2100000000	实例所属的账号 ID。
ArchType	String	Cluster	实例的架构类型。取值范围如下： Standard：不启用分片集群。 Cluster：启用分片集群。说明关于产品架构的更多信息，请参见产品架构。
BlueGreenRole	String	Blue	实例的蓝绿部署角色。取值范围如下： Blue：蓝色实例。 Green：绿色实例。说明仅使用过蓝绿部署功能的 Redis 实例会返回该参数。更多详情，请参见通过蓝绿部署升级大版本。
ChargeType	String	PrePaid	实例计费类型，取值范围如下： PostPaid：按量计费。 PrePaid：包年包月。说明关于计费类型的更多信息，请参见按量计费和包年包月。
DeletionProtection	String	enabled	实例的删除保护功能状态。取值范围如下： enabled：开启。 disabled：关闭。说明关于删除保护功能的更多信息，请参见实例删除保护。
EngineVersion	String	5.0	实例的数据库版本。
ExpiredTime	String	2024-09-01 23:59:59	实例到期时间，格式为 yyyy-MM-dd HH:mm:ss（UTC+8）。说明仅包年包月实例（即 ChargeType 为 PrePaid），会返回该参数。
InstanceId	String	redis-cn0212gzmh2xs****	实例 ID。
InstanceName	String	test	实例名称。
RegionId	String	cn-beijing	实例所属地域的地域 ID。
ShardCapacity	Double	1024	每个分片的内存容量。单位：MiB。
ShardNumber	Integer	2	实例中的分片数。
VpcId	String	vpc-rs5811nceqyov0x58x4****	实例的私有网络 ID。
ZoneIds	Array of String	["cn-beijing-a"]	实例所在的可用区列表。
MaintenanceTime	String	02:00-02:59	实例的可维护时间段，格式为 HH:mm-HH:mm（UTC+8）。说明关于可维护时间段的更多信息，请参见设置可维护时间段。
NetworkType	String	VPC	实例的网络类型，当前仅支持私有网络 VPC 类型。
Replicas	Integer	2	每个分片中的节点数。
TotalCapacity	Long	2048	实例总容量。单位：MiB。

示例

请求示例

返回示例

错误码

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

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

这个页面对您有帮助吗？

有用

有用

无用

无用