All Products
Search
Document Center

ApsaraDB for MongoDB:MigrateToOtherZone

Last Updated:Mar 15, 2024

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.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the instance.

Note If the network type of the instance is VPC, you must specify the Vswitch parameter .
dds-bp2658****
ZoneIdstringYes

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

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

    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.

    Immediately
    VSwitchIdstringNo

    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.
    vsw-bp67ac****

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    0FDDC511-7252-4A4A-ADDA-5CB1BF63873D

    Examples

    Sample success responses

    JSONformat

    {
      "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
    2024-01-23The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    Input ParametersThe request parameters of the API has changed.
      delete Input Parameters: Category
    2024-01-23The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: Category