Migrates an ApsaraDB for RDS instance from one zone to another.

For example, you can call this operation to migrate your instance from the cn-hangzhou-a zone to the cn-hangzhou-b zone in the China (Hangzhou) region.

Note You can only migrate your instance between zones within the same region. For example, you cannot migrate your instance from a zone in the China (Hangzhou) region to a zone in the China (Qingdao) region.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes MigrateToOtherZone

The operation that you want to perform. Set the value to MigrateToOtherZone.

DBInstanceId String Yes rm-uf6wjk5xxxxxxxxxx

The ID of the instance.
ZoneId String Yes cn-hangzhou-b

The ID of the destination zone. You can call the DescribeRegions operation to query the most recent region list.

VPCId String No vpc-xxxxxxx

The ID of the VPC to which the instance belongs. Do not change the VPC of the instance.

Note This parameter must be specified when the instance resides in a VPC.
EffectiveTime String No Immediate

The time you want the change to take effect. Valid values:

  • Immediate: The change takes effect immediately.
  • MaintainTime: The change takes effect during the maintenance window. For more information, see ModifyDBInstanceMaintainTime.

Default value: Immediate.

VSwitchId String No vsw-uf6adz52c2pxxxxxxx

The ID of the VSwitch associated with the specified VPC.

Note This parameter must be specified when the instance resides in a VPC.
Category String No HighAvailability

The edition of the instance. Valid values:

  • Basic: the Basic Edition.
  • HighAvailability: the High-availability Edition.
  • AlwaysOn: the Cluster Edition.
  • Finance: the Enterprise Edition.
ZoneIdSlave1 String No cn-hangzhou-c

The secondary zone numbered 1 of the instance.

Note You can specify this parameter when the instance is not in the Basic Edition.
ZoneIdSlave2 String No cn-hangzhou-d

The secondary zone numbered 2 of the instance.

Note You can only specify this parameter when the instance is in the Enterprise Edition.

Response parameters

Parameter Type Example Description
RequestId String 65BDA532-28AF-4122-AA39-B382721EEE64

The ID of the request.

Examples

Sample requests

http(s)://rds.aliyuncs.com/? Action=MigrateToOtherZone
&DBInstanceId=rm-uf6wjk5xxxxxxxxxx
&ZoneId=cn-hangzhou-b
&<Common request parameters>

Sample success responses

XML format 

<MigrateToOtherZoneResponse>
      <RequestId> 65BDA532-28AF-4122-AA39-B382721EEE64</RequestId></MigrateToOtherZoneResponse>

JSON format 

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

Error codes

HTTP status code Error code Error message Description
400 IncorrectDBInstanceLockMode.ValueNotSupported The Current DB instance lock mode does not support this operation. The error message returned because the lock mode of the instance does not support this operation.
403 OperationDenied.OutofUsage The resource is out of usage. The error message returned because the specified zone does not provide sufficient resources. Select another zone and try again.

For a list of error codes, visit the API Error Center.