文档中心

云数据库 MySQL 版

备份与恢复

DescribeCrossRegionBackupDBInstances - 查询开启过和开启了跨地域备份功能的实例列表

调用 DescribeCrossRegionBackupDBInstances 接口查询开启过和开启了跨地域备份功能的实例列表。

请求类型

同步请求。

注意事项

MySQL 8.4 版本的实例不支持跨地域备份功能。

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	否	mysql-ce1fee06****	实例 ID。说明传入该参数时，返回指定已删除实例的备份信息。不传时返回所有满足设定查询条件的结果。
InstanceName	String	否	测试实例	实例名称。支持模糊匹配。
PageNumber	Integer	否	1	当前页页码。最小值为 1。默认值为 1。
PageSize	Integer	否	10	每页记录数。最小值为 1，最大值不超过 100。默认值为 10。
EnableAfterTime	String	否	2024-10-14T23:35:08.000Z	查询的时间范围的起点。格式为 yyyy-MM-ddTHH:mm:ss.sssZ（UTC 时间）。说明时间范围的终点应晚于时间范围的起点（EnableBeforeTime）。
EnableBeforeTime	String	否	2024-10-15T08:39:28.000Z	查询的时间范围的终点。格式为 yyyy-MM-ddTHH:mm:ss.sssZ（UTC 时间）。说明时间范围的起点应早于时间范围的终点（EnableAfterTime）。
ProjectName	String	否	default	项目名称。支持按照项目进行查询。

返回参数

参数	类型	示例值	描述
Total	Integer	5	符合查询条件的结果总数。
Datas	Array of CRBackupServingInstanceInfo	请参见返回示例。	符合查询条件的开启了跨地域备份功能的实例列表。

CRBackupServingInstanceInfo

参数	类型	示例值	描述
BackupEnabled	Boolean	true	是否开启了跨地域备份功能。取值： true：开启。 false：未开启。
CrossBackupAllRetention	Boolean	true	实例释放前是否长期保留跨地域备份。取值： true：是。 false：否。
DBEngineVersion	String	MySQL_8_0	兼容版本。取值： MySQL_5_7：MySQL 5.7 版本。 MySQL_8_0：MySQL 8.0 版本。
InstanceId	String	mysql-ce1fee06****	实例 ID。
InstanceName	String	测试实例	实例名称。
InstanceStatus	String	Running	实例状态，取值： Creating：创建中。 Running：运行中。 Deleting：删除中。 Restarting：重启中。 Updating：变更中。 Restoring：恢复中。 Error：错误。 Upgrading：升级中。 Released：回收中。 Recycled：已回收。 MasterChanging：主节点切换中。 TDEUpdating：TDE 修改中。 Closed：关停。 Maintaining：维护中。 CreateFailed：创建失败。 Closing：关停中。 SSLUpdating：SSL 变更中。 AllowListMaintaining：白名单变更中。 Unknown：未知。 ProxyCreating：代理开启中。 ProxyDeleting：代理关闭中。 ChargeTypeChanging：计费类型变更中。 NetWorkChanging：网络变更中。
LogBackupEnabled	Boolean	true	是否开启了跨地域日志备份。取值： true：开启。 false：未开启。
ProjectName	String	default	项目名称
RegionId	String	cn-shanghai	跨地域备份所在地域 ID。
Retention	Integer	7	跨域备份的保留天数。说明当 CrossBackupAllRetention 取值为 true 时，该字段的返回值无效。
ServiceEnableTime	String	2024-05-14T12:05:34.000Z	服务的开启时间。格式为 yyyy-MM-ddTHH:mm:ss.sssZ（UTC 时间）。

示例

请求示例

返回示例

错误码

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

最近更新时间：2026.05.28 11:52:21

这个页面对您有帮助吗？

有用

无用