Help Center/Distributed Message Service for RabbitMQ/API Reference/APIs V2 (Recommended)/Other APIs/Listing AZ Information
Updated on 2025-12-29 GMT+08:00
View PDF

Listing AZ Information

Function

This API is used to query the AZ ID for creating an instance.

Calling Method

For details, see Calling APIs.

URI

GET /v2/available-zones

Request Parameters

None

Response Parameters

Status code: 200

Table 1 Response body parameters

Parameter

Type

Description

region_id

String

Definition:

Region ID.

Range:

N/A

available_zones

Array of available_zones objects

Definition:

Array of AZs.

Table 2 available_zones

Parameter

Type

Description

soldOut

Boolean

Definition:

Indicates whether resources are sold out.

Range:

  • true: Yes

  • false: No

id

String

Definition:

AZ ID.

Range:

N/A

code

String

Definition:

AZ code.

Range:

N/A

name

String

Definition:

AZ name.

Range:

N/A

port

String

Definition:

AZ port.

Range:

N/A

resource_availability

String

Definition:

Whether the AZ has available resources.

Range:

  • true: Yes

  • false: No

default_az

Boolean

Definition:

Whether the AZ is the default AZ.

Range:

  • true: Yes

  • false: No

remain_time

Long

Definition:

Remaining time, which is a Unix timestamp.

Range:

N/A

ipv6_enable

Boolean

Definition:

Whether IPv6 is supported.

Range:

  • true: Yes

  • false: No

Example Requests

GET https://{endpoint}/v2/available-zones

Example Responses

Status code: 200

The AZ information is queried successfully.

{
  "region_id" : "xxx",
  "available_zones" : [ {
    "soldOut" : false,
    "id" : "d539378ec1314c85b76fefa3f7071458",
    "code" : "xxx",
    "name" : "AZ 2.",
    "port" : "8003",
    "resource_availability" : "true",
    "default_az" : true,
    "remain_time" : 9223372036854776000,
    "ipv6_enable" : false
  }, {
    "soldOut" : false,
    "id" : "9f1c5806706d4c1fb0eb72f0a9b18c77",
    "code" : "xxx",
    "name" : "AZ 3.",
    "port" : "443",
    "resource_availability" : "true",
    "default_az" : false,
    "remain_time" : 9223372036854776000,
    "ipv6_enable" : false
  } ]
}

Status Codes

Status Code

Description

200

The AZ information is queried successfully.

Error Codes

See Error Codes.

Parent Topic: Other APIs