Help Center/ Document Database Service/ API Reference/ APIs V3.0 (Recommended)/ DB Instance Management/ Querying AZs to Which an Instance Can Be Migrated
Updated on 2025-10-24 GMT+08:00
View PDF

Querying AZs to Which an Instance Can Be Migrated

Function

This API is used to query the AZs to which instances can be migrated.

Constraints

  • To use this API, contact related personnel.
  • 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.

URI

  • URI format

    GET /v3/{project_id}/instances/{instance_id}/migrate/az

  • URI example

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

Table 1 Path parameters

Name

Mandatory

Type

IN

Description

project_id

Yes

string

path

Explanation:

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

Constraints:

N/A

Value range:

N/A

Default value:

N/A

instance_id

Yes

string

path

Explanation:

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.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Name

Mandatory

Type

IN

Description

X-Auth-Token

Yes

string

header

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Table 3 Parameter description

Name

Type

Mandatory

Description

az_list

Array of objects

Yes

Definition

AZ information. For more information, see Table 4.

Range

N/A
Table 4 az_list field data structure description

Name

Type

Mandatory

Description

code

String

Yes

Definition

The AZ ID.

Range

N/A

description

String

Yes

Definition

AZ description.

Range

N/A

status

String

Yes

Definition

Status of the current AZ.

Range

  • ENABLED: indicates that the AZ (group) is available.
  • DISABLED: indicates that the AZ (group) is unavailable.

Example Requests

None

Example Responses

{
    "az_list": [
        {
            "code": "az3xahz",
            "description": "AZ 3",
            "status": "DISABLED"
            }
           {
            "code": "az1xahz,az2xahz,az3xahz",
            "description": "AZ 1, AZ 2, AZ 3",
            "status": "ENABLED"
            }
     ]
}

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.

Parent topic: DB Instance Management