Help Center/ Document Database Service/ API Reference/ APIs V3.0 (Recommended)/ DB Instance Management/ Migrating a DB Instance to Another AZ
Updated on 2024-04-02 GMT+08:00
View PDF
Share

Migrating a DB Instance to Another AZ

API Description

This API is used to migrate a DB instance to another AZ.

Service will be interrupted for up to 60 seconds while the AZ is being changed. The time required to change an AZ depends on the amount of data to be migrated. The entire migration process may take an hour. You are advised to use the HA connection to access the instance or configure your client to automatically reconnect to the instance.

Restrictions

  • DDS Community Edition clusters and replica sets support this operation.
  • Cross-AZ instances do not support this operation.
  • DB instances created using an IPv6 subnet do not support this operation.
  • Read replicas or inactive standby nodes in a replica set instance do not support this operation.
  • If a cluster instance has read replicas associated, the instance cannot be migrated to another AZ.

URI

  • URI format

    POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/migrate

  • URI example

    https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/migrate

Table 1 Request parameters

Name

Type

IN

Mandatory

Description

X-Auth-Token

string

header

Yes

User token obtained from IAM. For details, see Authentication.

project_id

string

path

Yes

Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.

instance_id

string

path

Yes

Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one.

Requests

  • Parameter description
    Table 2 Parameter description

    Name

    Type

    Mandatory

    Description

    target_azs

    String

    Yes

    Single-AZ or multi-AZ to which the VM is migrated. The value is obtained from the code field in the response body of the API in Querying AZs to Which an Instance Can Be Migrated.

Example Request

  • Migrating a DB instance from one AZ to another AZ 
    { 
        "target_azs":"az1xahz"
}
  • Migrating a DB instance from a single AZ to multiple AZs 
    {
	"target_azs":"az1xahz,az2xahz,az3xahz"
}

Responses

  • Parameter description
    Table 3 Parameter description

    Name

    Type

    Mandatory

    Description

    job_id

    String

    Yes

    The task ID.
  • Response example 
    { 
    "job_id": "3711e2ad-5787-49bc-a47f-3f0b066af9f5" 
}

SDK

Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.

Parent topic: DB Instance Management