MigrateToOtherZone - ApsaraDB for MongoDB - Alibaba Cloud Documentation Center

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

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.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
dds:MigrateToOtherZone	update	*Instance `acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}`	none	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 parameters

Parameter	Type	Description	Example
	object
RequestId	string	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 code	Error code	Error message	Description
400	InvalidEffectiveTime.Malformed	Specified EffectiveTime is not valid.	The EffectiveTime parameter is empty.

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

Change history

Change time	Summary of changes	Operation
2025-04-28	The Error code has changed	View Change Details
2024-01-23	The Error code has changed. The request parameters of the API has changed	View Change Details
2024-01-23	The Error code has changed. The request parameters of the API has changed	View Change Details