You can call this operation to migrate MongoDB instance to another zone.

This operation is applicable to replica set instances. MigrateAvailableZone cannot be performed on standalone instances and sharded cluster instances.

Note If you have applied a public network address to the instance, you must first call ReleasePublicNetworkAddress to release the public network address.


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

Name Type Required Example Description
Action String No MigrateToOtherZone

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

InstanceId String Yes dds-bpxxxxxxxx

The ID of the instance.

Note You must specify the Vswitch parameter if the network type of the instance is VPC.
ZoneId String Yes cn-hangzhou-b

The ID of the destination zone which you want to migrate the MongoDB instance.

  • The destination zone and the current zone of the instance must be in the same region.
  • You can call DescribeRegions to query the IDs of zones in Alibaba Cloud.
EffectiveTime String No Immediately

The time when the instance is migrated to the destination zone. Valid values:

  • Immediately
  • MaintainTime: The instance will be migrated during the maintenance period of the instance.

Default value:Immediately.

VSwitchId String No vsw-bpxxxxxxxx

The ID of the VSwitch in the destination zone.

Note This parameter can be specified only when the network type of the instance is VPC.

Response parameters

Parameter Type Example Description
RequestId String 0FDDC511-7252-4A4A-ADDA-5CB1BF63873D

The ID of the request.


Sample requests

http(s):// Action=MigrateToOtherZone
&<Common request parameters>

Sample success responses

XML format


JSON format

    "RequestId": "0FDDC511-7252-4A4A-ADDA-5CB1BF63873D"

Error codes

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