You can call this operation to change the zone of a MongoDB instance.

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.

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 MigrateAvailableZone

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

DBInstanceId 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 to which you want to migrate the MongoDB instance.

Note
  • The destination zone must be in the same region as the current zone of the instance.
  • You can callDescribeRegionsto query the IDs of zones in Alibaba Cloud.
Vswitch 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.
EffectiveTime String Yes 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.

Response parameters

Prameter Type Sample response Description
RequestId String 0FDDC511-7252-4A4A-ADDA-5CB1BF63873D

The ID of the request.

Examples

Sample requests

http(s)://mongodb.aliyuncs.com/? Action=MigrateAvailableZone
&DBInstanceId=dds-bpxxxxxxxx
&ZoneId=cn-hangzhou-b
&EffectiveTime=Immediately
&<Common request parameter>

Sample success response

XML format 

<MigrateAvailableZoneResponse>
      <RequestId>0FDDC511-7252-4A4A-ADDA-5CB1BF63873D</RequestId>
</MigrateAvailableZoneResponse>

JSON format 

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

Error codes.

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