预检查跨地域备份 - 云数据库 RDS

仅适用于如下实例类型：

RDS MySQL：支持的实例版本请参见MySQL跨地域备份。
RDS SQL Server：支持的实例版本请参见SQL Server跨地域备份。
RDS PostgreSQL ：支持的实例版本请参见PostgreSQL跨地域备份。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	CheckCreateDdrDBInstance	系统规定参数，取值：CheckCreateDdrDBInstance。
DBInstanceClass	String	是	rds.mysql.s1.small	目的实例规格，详见实例规格表。
DBInstanceStorage	Integer	是	20	目的实例存储空间，取值： 5~2000。每5G进行递增，单位：GB。详见实例规格表。
Engine	String	是	MySQL	目标数据库类型，取值： MySQL SQLServer PostgreSQL
EngineVersion	String	是	5.6	目标数据库版本。根据Engine参数取值的不同，本参数取值如下： MySQL：5.5/5.6/5.7/8.0 SQL Server：2008r2/08r2_ent_ha/2012/2012_ent_ha/2012_std_ha/2012_web/2014_std_ha/2016_ent_ha/2016_std_ha/2016_web/2017_std_ha/2017_ent/2019_std_ha/2019_ent PostgreSQL：9.4/10.0/11.0/12.0/13.0
RegionId	String	是	cn-hangzhou	目的实例地域ID，可以通过接口DescribeRegions查看地域ID。
RestoreType	String	是	0	恢复方式，取值： 0：基于备份集恢复，您还需要传入参数BackupSetId。 1：基于时间点恢复，您还需要传入参数RestoreTime、SourceRegion、SourceDBInstanceName。默认值：0。
BackupSetId	String	否	14358	基于备份集恢复时，使用的备份集的ID。可以通过接口DescribeCrossRegionBackups查看备份集ID。说明 RestoreType=0时必传。
RestoreTime	String	否	2019-05-30T03:29:10Z	基于时间点恢复时，要恢复的时间节点，需要早于当前时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。说明 RestoreType=1时必传。
SourceRegion	String	否	cn-hangzhou	基于时间点恢复时，源地域的ID。说明 RestoreType=1时必传。
SourceDBInstanceName	String	否	rm-uf6wjk5xxxxxxx	基于时间点恢复时，源实例的ID。说明 RestoreType=1时必传。

返回数据


名称	类型	示例值	描述
IsValid	String	true	是否能创建容灾恢复实例，取值：true \| false
RequestId	String	1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC	请求ID。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=CheckCreateDdrDBInstance
&RegionId=cn-hangzhou
&Engine=MySQL
&DBInstanceClass=rds.mysql.s1.small
&DBInstanceStorage=20
&EngineVersion=5.6
&RestoreType=0
&BackupSetId=14358
&<公共请求参数>

正常返回示例

XML格式

<CheckCreateDdrDBInstanceResponse>
    <IsValid>true</IsValid>
    <RequestId>346C62D7-8BB9-4516-93E7-25A469EAABCB</RequestId>
</CheckCreateDdrDBInstanceResponse>

JSON格式

{
	"IsValid": "true",
	"RequestId": "346C62D7-8BB9-4516-93E7-25A469EAABCB"
}

错误码


HttpCode	错误码	错误信息	描述
400	IncorrectDBInstanceType	Current DB instance engine and type does not support operations.	当前DB实例引擎和类型不支持操作。
400	InvalidRestoreType.Format	Specified restore type is not valid.	指定的恢复类型无效。
400	IncorrectBackupSetMethod	Current backup set method does not support operations.	指定的备份集不支持库表恢复
400	InvalidBackupType.Format	Specified backup type is not valid.	指定的备份类型无效。

访问错误中心查看更多错误码。