调用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不能变更,需保持不变。

说明
  • 专有网络实例迁移可用区时必须传入该参数。
  • 如果实例引擎为SQL Server,迁移可用区VPC可支持变更。
ZoneId String cn-hangzhou-b

目标可用区ID,可以通过DescribeRegions接口查看。

EffectiveTime String Immediate

生效时间,取值:

  • Immediate:默认值,立即生效。
  • MaintainTime:在可运维时间段内生效,请参见ModifyDBInstanceMaintainTime
  • ScheduleTime:手动指定生效时间。
说明 如果在本参数中传入ScheduleTime,则还需要传入SwitchTime参数。
VSwitchId String vsw-uf6adz52c2pxxxxxxx

交换机ID。

说明
  • 专有网络实例迁移可用区时必须传入该参数。可通过调用DescribeVSwitches接口查询已创建的交换机。
  • 当RDS PostgreSQL、SQL Server实例迁移可用区配置了备可用区时,此参数可以配置多个,用英文逗号(,)分隔,与可用区对应。
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时需要传入。
IsModifySpec String true

是否在迁移可用区时变配。

  • true:变配,当配置为true时,至少需要配置DBInstanceClassDBInstanceStorage中的一个参数。
  • false:默认值,不变配。
说明 该参数仅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 RenewChange.Exist The Current InstanceId existed renewChange order in RDS. 当前存在变配任务未完成,请等待完成后重试。
400 InvalidMigrateModifyClassOrStorage Specified parameter DBInstanceClass or Storage is invalid. 指定的参数DBInstanceClass或Storage无效.
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 InsufficientResourceCapacityCheck There is insufficient capacity available for the requested instance with precheck. 具有预检查的请求实例的可用容量不足。
400 IncorrectDBInstanceState Current DB instance state does not support this operation. 操作失败,该实例状态下不支持此操作。
400 SSLInstanceNotSupportThisOperation The instance opened SSL, upgrade is not this operation 开启SSL功能的实例不支持此操作
400 BYOLInstanceNotSupportThisOperation The BYOL instance is not supported this operation BYOL实例不支持此操作
400 BYOKInstanceNotSupportThisOperation The BYOK instance is not supported this operation 开启云盘加密功能的实例不支持此操作
400 ADInstanceNotSupportThisOperation The AD instance is not supported this operation 加入AD域的实例不支持此操作
400 TDEInstanceNotSupportThisOperation The instance opened TDE, this operation is not supported 开启TDE功能的实例不支持此操作
400 InstanceIsSnapshotBackupNotSupportThisOperation The instance backup method is snapshot backup, this operation is not supported 开启快照备份的实例不支持此操作
400 InstanceHasReadOnlyInstanceNotSupportThisOperation The instance has read-only instance or is read-only instance, this operation is not supported 该实例有只读实例或者该实例是只读实例,不支持此操作
400 VswitchIpExhausted No available ip in the specified vswitch. 指定的vswitch中没有可用的IP。
400 OperationDenied.MasterDBInstanceState The operation is not permitted due to status of master instance. 操作失败,当前状态的主实例不支持此操作,当主实例状态为运行状态后再重试。
400 InvalidShareInstance.NotSupport The share dbInstance is not support. 共享型实例不支持
400 InvalidZoneIdSlave1.Missing The parameter ZoneIdSlave1 must be specified. 备可用区ID不能为空。
400 MigrateAlreadyExistsFault The rds instance already has a given vpc migrate task. RDS实例档已存在一个VPC迁移任务。
400 InvalidInstanceKind.NotSupport The instance kind does not support this operation. 实例类型不支持此操作。
400 MissingCategory The instance is missing a category parameter. 实例缺少类别参数。
400 InvalidInstanceNodeType.NotFound The specified NodeType is not found. NodeType参数缺失,请重新配置。
400 EngineVersionNotSupported EngineVersion specified cannot be replicate with the source DB Instance. 当前数据库引擎版本不支持克隆实例。
400 CommodityCodeNotFound CommodityCodeNotFound 指定的参数CommodityCode无效,请检查该参数的正确性。
403 OperationDenied.OutofUsage The resource is out of usage. 当前集群的资源不足,请选择其它可用区。
403 IncorrectEffectiveTime The specified EffectiveTime params is not valid. EffectiveTime参数无效。
403 InvalidTempInstance.NotSupport The temp db Instance is not support. 操作失败,当前实例已被锁定。
403 OperationDenied.LockMode The operation is not permitted due to instance being locked. 实例锁定中,不支持该操作。请检查实例的存储空间是否已满,或者实例是否已到期。若磁盘空间已满,请进行变更配置,扩大存储空间后即可解锁;若实例已到期,续费后即可解锁。
403 ClassicNetworkType.NotSupport The Classic instance network create is not support. 操作失败,当前实例不支持创建经典网络类型,请创建其他网络类型的实例。
403 InstanceNetworkTypeNotFoundFault The specified DBInstanceNetworkType is not found. 检查网络类型失败,实例网络类型不存在。
403 ProprietaryCloud.NotSupported The proprietary cloud not supported. 专有云不支持。
403 MigrateAlreadyReadWriteSplitExistsFault The rds instance already has a given vpc migrate task. RDS实例已存在指定VPC迁移任务。
403 InvalidRegionAvzNotFound Specified user does not find the region and avz. 指定的用户找不到区域和avz。
403 ZoneIdNotSupported The zone ID is not supported. 操作失败,不支持区域ID。
404 InvalidDBInstanceName.NotFound The database instance does not exist. 数据库实例名称不存在。请确认数据名称是否正确。
404 IncorrectVswitchId The specified parameter VSwitchId is not valid. 交换机参数无效。

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