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

Querying AZs to Which an Instance Can Be Migrated

API Description

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

Restrictions

  • 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 https://{Endpoint}/v3/{project_id}/instances/{instance_id}/migrate/az

Table 1 Path parameters

Name

Type

IN

Mandatory

Description

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.

Request Parameters

Table 2 Request header parameters

Parameter

Type

IN

Mandatory

Description

X-Auth-Token

string

header

Yes

User token.

Response Parameters

Table 3 Parameter description

Name

Type

Mandatory

Description

az_list

Array of objects

Yes

AZ information. For more information, see Table 4.
Table 4 az_list field data structure description

Name

Type

Mandatory

Description

code

String

Yes

The AZ ID.

description

String

Yes

AZ description.

status

String

Yes

Status of the current AZ.

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

Status Code

For details, see Status Code.

Error Code

For details, see Error Code.

Parent topic: DB Instance Management