All Products
Document Center

ApsaraDB for MongoDB:MigrateToOtherZone

Last Updated:Jan 17, 2023

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

Operation Description

This operation is applicable only to replica set instances, but not to standalone instances or sharded cluster instances.

Note If you have applied for a public endpoint of the instance, you must first call the ReleasePublicNetworkAddress operation to release the public endpoint.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
  • Condition keyword: refers to the condition keyword defined by the cloud product itself.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operate access level Resource type conditional keyword Association operation
dds:MigrateToOtherZone WRITE
  • MongoDB

Request parameters

Parameter Type Required Description Example
InstanceId string Yes

The ID of the instance.

Note If the network type of the instance is VPC, you must specify the Vswitch parameter .
ZoneId string Yes

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

  • The destination and source zones must be in one region.
  • You can call DescribeRegions to query the zone IDs.
  • cn-hangzhou-b
    EffectiveTime string No

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

    • Immediately: The instance is immediately migrated to the destination zone.
    • MaintainTime: The instance is migrated during the maintenance period of the instance.

    Default value: Immediately.

    VSwitchId string No

    The ID of the vSwitch in the destination zone.

    Note This parameter is valid and required only when the network type of the instance is VPC.

    Response parameters

    Parameter Type Description Example
    RequestId string

    The ID of the request.



    Normal return example


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

    Error codes

    Http code Error code Error message
    400 InvalidEffectiveTime.Malformed Specified EffectiveTime is not valid.

    For a list of error codes, visit the API error center.