All Products
Search
Document Center

PolarDB:MigrateDBInstance

Last Updated:Sep 10, 2026

Migrates an instance from one zone to another.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

The region ID of the instance.

cn-hangzhou

SwitchMode

string

No

The switchover mode. Valid values:

  • 0: immediately switches over.

  • 1: switches over within the O&M window.

0

DBInstanceName

string

Yes

The instance ID.

pxc-xxx

TopologyType

string

Yes

The topology type. Valid values:

  • 3azones: three-zone deployment.

  • 1azone: single-zone deployment.

3azones

PrimaryZoneId

string

Yes

The zone ID of the primary zone for a multi-zone instance. This parameter is required if you want to create a multi-zone instance..

cn-zhangjiakou-b

SecondaryZoneId

string

No

The secondary zone ID.

Note

This parameter cannot be set to the same value as ZoneId.

cn-beijing-l

TertiaryZoneId

string

No

The zone ID for Three-zone deployment.

cn-beijing-h

VpcId

string

No

The ID of the virtual private cloud (VPC) where the access endpoint resides.

vpc-****

VswitchId

string

No

The vSwitch ID. This parameter is required when you create a DRDS instance of the VPC network type.

vsw-****

Response elements

Element

Type

Description

Example

object

MigrateDBInstanceResponse

Success

boolean

Indicates whether the request was successful.

true

Message

string

Returns success if the request was successful, or an error code if the request failed.

*****

RequestId

string

The request ID.

FEA5DC20-6D8A-5979-97AA-FC57546ADC20

Examples

Success response

JSON format

{
  "Success": true,
  "Message": "*****",
  "RequestId": "FEA5DC20-6D8A-5979-97AA-FC57546ADC20"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.