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.
Debugging
OpenAPI Explorer simplifies API usage. You can use OpenAPI Explorer to perform debugging operations, such as retrieve APIs, call APIs, and dynamically generate SDK example code.
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
|
| EffectiveTime | String | Yes | Immediately |
The time when the instance is migrated to the destination zone. Valid values:
Default value: Immediately. |
| Vswitch | String | No | 1 |
The ID of the VSwitch in the destination zone. Note This parameter can be used only when the network type of the instance is VPC.
|
| AccessKeyId | String | No | LTAIgbTGpxxxxxx |
The AccessKey ID provided to you by Alibaba Cloud. |
Response parameters
| Parameter | Type | Example | 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 parameters>
Successful response examples
XML format
<MigrateAvailableZoneResponse>
<RequestId>0FDDC511-7252-4A4A-ADDA-5CB1BF63873D</RequestId>
</MigrateAvailableZoneResponse>
JSON format
{
"RequestId":"0FDDC511-7252-4A4A-ADDA-5CB1BF63873D"
}