Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Instance Management/ Obtaining the AZ Where a Log Node Resides
Updated on 2026-04-28 GMT+08:00
View PDF
Share

Obtaining the AZ Where a Log Node Resides

Function

This API is used to obtain the AZ where a log node resides. Before calling this API:

Constraints

This API is only available for distributed instances (1 primary + 2 standby) in the independent deployment.

Debugging

You can debug this API in API Explorer.

URI

GET /v3/{project_id}/instances/{instance_id}/switch-logger-replica/availability_zones

Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

The value can contain 36 characters. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token.

You can obtain the token by calling the IAM API used to obtain a user token.

After a response is returned, the value of X-Subject-Token in the response header is the token.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Language.

Constraints

N/A

Range

  • zh-cn
  • en-us

Default Value

en-us

Response Parameters

Table 3 Response body parameters

Parameter

Type

Description

availability_zone_infos

Array of objects

Definition

AZ information list. For details, see Table 4.
Table 4 Data structure description of the availability_zone_infos field

Parameter

Type

Description

availability_zone

String

Definition

AZ ID.

Range

N/A

description

String

Definition

AZ name.

Range

N/A

Example Request

Obtaining the AZ where a log node resides 
GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/5362449138da4e408dbae5152ca26640in14/switch-logger-replica/availability_zones

Example Response

{ 
  "availability_zone_infos": [
        {
            "availability_zone": "aaa",
            "description": "AZ aaa",
        },
        {
            "availability_zone": "bbb",
            "description": "AZ bbb",
        },
  ]
}

Status Code

Error Codes

For details, see Error Codes.

Parent topic: Instance Management