Help Center/ Distributed Message Service for RocketMQ/ API Reference/ APIs V2 (Recommended)/ Other APIs/ Querying AZ Information
Updated on 2026-04-30 GMT+08:00
View PDF

Querying AZ Information

Function

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

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.

Constraints

N/A

Range

N/A

Default Value

N/A

available_zones

Array of ListAvailableZonesElements objects

Definition

Array of AZs.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 2 ListAvailableZonesElements

Parameter

Type

Description

soldOut

Boolean

Definition

Whether resources are sold out.

Constraints

N/A

Range

  • true: Yes

  • false: No

Default Value

N/A

id

String

Definition

AZ ID.

Constraints

N/A

Range

N/A

Default Value

N/A

code

String

Definition

AZ code.

Constraints

N/A

Range

N/A

Default Value

N/A

name

String

Definition

AZ name.

Constraints

N/A

Range

N/A

Default Value

N/A

port

String

Definition

AZ port.

Constraints

N/A

Range

N/A

Default Value

N/A

resource_availability

String

Definition

Whether the AZ has available resources.

Constraints

N/A

Range

N/A

Default Value

N/A

default_az

Boolean

Definition

Whether the AZ is the default one.

Constraints

N/A

Range

  • true: Yes

  • false: No

Default Value

N/A

remain_time

Long

Definition

Remaining time.

Constraints

N/A

Range

N/A

Default Value

N/A

ipv6_enable

Boolean

Definition

Whether IPv6 is supported.

Constraints

N/A

Range

  • true: Yes

  • false: No

Default Value

N/A

mode

String

Definition

AZ mode.

Range

  • dedicated: edge AZ

  • shared: local AZ

  • center: central AZ

scope

String

Definition

AZ group.

Constraints

N/A

Range

N/A

Default Value

N/A

Example Requests

Querying AZ information

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

Example Responses

Status code: 200

AZ information queried successfully.

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

Status Codes

Status Code

Description

200

AZ information queried successfully.

Error Codes

See Error Codes.

Parent Topic: Other APIs