All Products
Document Center

ApsaraDB for MongoDB:MigrateToOtherZone

Last Updated:Nov 06, 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.


You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.


Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • 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 Key: the condition key that is defined by the cloud service.
  • 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.
OperationAccess levelResource typeCondition keyAssociated operation
  • DBInstance

Request parameters


The ID of the instance.

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

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

    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.


    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


    The ID of the request.



    Sample success responses


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

    Error codes

    HTTP status codeError codeError message
    400InvalidEffectiveTime.MalformedSpecified EffectiveTime is not valid.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    No change history