MigrateToOtherZone - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dds:MigrateToOtherZone

update

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}

None

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 .	dds-bp2658****
ZoneId	string	Yes	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
EffectiveTime	string	No	The time when the instance is migrated to the destination zone. Valid values: Immediately (default): The instance is migrated immediately. MaintainTime: The instance is migrated during its maintenance window.	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.	vsw-bp67ac****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	0FDDC511-7252-4A4A-ADDA-5CB1BF63873D

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidEffectiveTime.Malformed	Specified EffectiveTime is not valid.
400	MigrateDBInstanceError	Error in migrating available area or changing your vpc network. Please submit the work order for processing.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.