MigrateConnectionToOtherZone - ApsaraDB RDS - Alibaba Cloud Documentation Center

Migrates an instance to a different zone.

Operation description

Supported database engines

MySQL
PostgreSQL
SQL Server

References

Note Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.

Debugging

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

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:
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
rds:MigrateConnectionToOtherZone	update	DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID. You can call the DescribeDBInstances operation to query the instance ID.	rm-bp1oypo6ky19y****
ConnectionString	string	Yes	The endpoint of the instance. The endpoint is specified when you create the instance.	rm-bp1oypo6ky19y****
ZoneId	string	Yes	The ID of the zone.	cn-hangzhou-i

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
Code	string	The error code.	InvalidParam
Message	string	The error message.	Invalid Parameter.
RequestId	string	The ID of the request.	65BDA532-28AF-4122-AA39-B382721EEE64

Examples

Sample success responses

JSONformat

{
  "Code": "InvalidParam",
  "Message": "Invalid Parameter.",
  "RequestId": "65BDA532-28AF-4122-AA39-B382721EEE64"
}

Error codes

HTTP status code	Error code	Error message	Description
403	ZoneIdNotSupported	The zone ID is not supported.	The operation failed. The operation is not supported in the region.
403	ConnectionNotFound	The connection is not found.	The operation failed. The connection cannot be found.
403	DBInstanceStatusNotActive	The status of the current instance is not active.	The operation failed. Check the status of the RDS instance.
404	InvalidParam	The specified parameter is invalid.	-
404	InvalidDBInstance.NotFound	The specified instance does not exist or is not supported.	The RDS instance cannot be found. Check the ID or name of the RDS instance.

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

Change history

Change time	Summary of changes	Operation
2022-06-20	Add Operation	View Change Details