All Products
Search
Document Center

ApsaraDB RDS:MigrateConnectionToOtherZone

Last Updated:Dec 05, 2024

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

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
rds:MigrateConnectionToOtherZoneupdate
*DBInstance
acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The instance ID. You can call the DescribeDBInstances operation to query the instance ID.

rm-bp1oypo6ky19y****
ConnectionStringstringYes

The endpoint of the instance. The endpoint is specified when you create the instance.

rm-bp1oypo6ky19y****
ZoneIdstringYes

The ID of the zone.

cn-hangzhou-i

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Codestring

The error code.

InvalidParam
Messagestring

The error message.

Invalid Parameter.
RequestIdstring

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 codeError codeError messageDescription
403ZoneIdNotSupportedThe zone ID is not supported.The operation failed. The operation is not supported in the region.
403ConnectionNotFoundThe connection is not found.The operation failed. The connection cannot be found.
403DBInstanceStatusNotActiveThe status of the current instance is not active.The operation failed. Check the status of the RDS instance.
404InvalidParamThe specified parameter is invalid.-
404InvalidDBInstance.NotFoundThe 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 timeSummary of changesOperation
2022-06-20Add OperationView Change Details