调用MigrateToOtherZone接口将RDS实例迁移至其他可用区。
不同引擎实例切换可用区的前提条件不同。更多信息,请参见:
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | MigrateToOtherZone |
系统规定参数。取值:MigrateToOtherZone。 |
DBInstanceId | String | 是 | rm-uf6wjk5xxxxxxxxxx |
实例ID。可调用DescribeDBInstances获取。 |
VPCId | String | 否 | vpc-xxxxxxx |
专有网络VPC ID。迁移可用区时VPC不能变更,需保持不变。 说明
|
ZoneId | String | 是 | cn-hangzhou-b |
目标可用区ID,可以通过DescribeRegions接口查看。 |
EffectiveTime | String | 否 | Immediate |
生效时间,取值:
说明 如果在本参数中传入ScheduleTime,则还需要传入SwitchTime参数。
|
VSwitchId | String | 否 | vsw-uf6adz52c2pxxxxxxx |
交换机ID。 说明
|
Category | String | 否 | HighAvailability |
实例系列,取值:
|
ZoneIdSlave1 | String | 否 | cn-hangzhou-c |
备可用区1。 说明 非基础版实例需要传入该参数。
|
ZoneIdSlave2 | String | 否 | cn-hangzhou-d |
备可用区2。 说明 仅三节点企业版实例可传入该参数。
|
SwitchTime | String | 否 | 2021-12-14T15:15:15Z |
切换可用区的自定义生效时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 说明 本参数配合EffectiveTime参数使用,仅在EffectiveTime为ScheduleTime时需要传入。
|
IsModifySpec | String | 否 | true |
是否在迁移可用区时变配。
说明 该参数仅RDS MySQL实例适用。
|
DBInstanceClass | String | 否 | mysql.x4.xlarge.2 |
目标实例规格代码,只支持变更规格,不支持变更存储类型。 当IsModifySpec参数配置为true时,至少需要配置本参数和DBInstanceStorage中的一个。 实例规格代码请参见RDS MySQL主实例规格列表。 |
DBInstanceStorage | Long | 否 | 500 |
目标存储空间大小。当IsModifySpec参数配置为true时,至少需要配置本参数和DBInstanceClass中的一个。 单位:GB。 取值范围:不同规格可扩容存储空间大小不同,具体请以RDS MySQL主实例规格列表为准。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 65BDA532-28AF-4122-AA39-B382721EEE64 |
请求ID。 |
DBInstanceId | String | rm-uf6wjk5xxxxxxxxxx |
实例ID。 |
OrderId | Long | 213341575990728 |
订单ID,仅MySQL实例适用。 |
示例
请求示例
http(s)://rds.aliyuncs.com/?Action=MigrateToOtherZone
&DBInstanceId=rm-uf6wjk5xxxxxxxxxx
&ZoneId=cn-hangzhou-b
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<MigrateToOtherZoneResponse>
<RequestId>65BDA532-28AF-4122-AA39-B382721EEE64</RequestId>
<DBInstanceId>rm-uf6wjk5xxxxxxxxxx</DBInstanceId>
</MigrateToOtherZoneResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "65BDA532-28AF-4122-AA39-B382721EEE64",
"DBInstanceId" : "rm-uf6wjk5xxxxxxxxxx"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | EngineNotSupported | Engine specified cannot be supported the operation. | 操作失败,当前引擎不支持此操作,请升级内核小版本。 |
400 | IncorrectDBInstanceLockMode.ValueNotSupported | The Current DB instance lock mode does not support this operation. | 操作失败,当前数据库实例锁模式不支持此操作。 |
400 | InvalidZoneId.NotNull | The parameter ZoneId must not be null or auto | 参数ZoneId不能为null或auto |
400 | InvalidZoneId.NotEqual | The parameter ZoneId is the same as the previous one | 操作失败,两个可用区相同。 |
400 | IncorrectDBInstanceType | Current DB instance type does not support this operation. | 操作失败,该实例状态下不支持此操作。 |
400 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | 操作失败,该实例状态下不支持此操作。 |
403 | OperationDenied.OutofUsage | The resource is out of usage. | 当前集群的资源不足,请选择其它可用区。 |
访问错误中心查看更多错误码。