调用MigrateToOtherZone接口将RDS实例迁移至其他可用区。

不同引擎实例切换可用区的前提条件不同。更多信息,请参见:

说明 仅支持迁移到同一地域的其它可用区,不支持迁移到其它地域的可用区,如华东1(杭州)可用区内的实例不支持迁移至华北1(青岛)的可用区。

调试

您可以在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

生效时间,取值:

  • Immediate:立即生效。
  • MaintainTime:在可运维时间段内生效,请参见ModifyDBInstanceMaintainTime
  • ScheduleTime:手动指定生效时间。

默认值:Immediate

说明 如果在本参数中传入ScheduleTime,则还需要传入SwitchTime参数。
VSwitchId String vsw-uf6adz52c2pxxxxxxx

交换机ID。

说明 专有网络实例迁移可用区时必须传入该参数。
Category String HighAvailability

实例系列,取值:

  • Basic:基础版
  • HighAvailability:高可用版
  • AlwaysOn:集群版
  • Finance:三节点企业版
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参数使用,仅在EffectiveTimeScheduleTime时需要传入。

返回数据

名称 类型 示例值 描述
RequestId String 65BDA532-28AF-4122-AA39-B382721EEE64

请求ID。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=MigrateToOtherZone
&DBInstanceId=rm-uf6wjk5xxxxxxxxxx
&ZoneId=cn-hangzhou-b
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<MigrateToOtherZoneResponse>
	<RequestId> 65BDA532-28AF-4122-AA39-B382721EEE64</RequestId></MigrateToOtherZoneResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : " 65BDA532-28AF-4122-AA39-B382721EEE64"
}

错误码

HttpCode 错误码 错误信息 描述
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. 操作失败,该实例状态下不支持此操作。
403 OperationDenied.OutofUsage The resource is out of usage. 当前集群的资源不足,请选择其它可用区。

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