Docs

Message Queue for Kafka

Resource check

DescribeAvailabilityZones - View the availability zone list

Call the DescribeAvailabilityZones API to view the availability zone list.

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Only the unique request parameters of this interface and some common parameters are listed below. For more information, see common parameters.

Action string required Example value: DescribeAvailabilityZones

Actions to execute, value: DescribeAvailabilityZones.

Version string required Example value: 2022-05-01

API version, value: 2022-05-01.

RegionId string required Example value: cn-beijing

Region ID, which is the ID used to query the list of availability zones in that region.

You can query the Region ID by calling DescribeRegions.

Response parameters

Only the unique response parameters of this API are listed below. For more details, see response structure.

RegionId string Example value: cn-beijing

Region ID.

Zones object[] Example value: --

availability zone list.

ZoneId string Example value: cn-beijing-a

availability zone ID

ZoneName string Example value: cn-beijing-a

availability zone name.

Description string Example value: availability zone A

Region availability zone Chinese name.

Status string Example value: Normal

Availability zone status includes the following states:

Normal: available for sale.

Soldout: sold out.

Unavailable: disabled.

Request example

POST /?Action= DescribeAvailabilityZones&Version=2022-05-01 HTTP/1.1​
Content-Type: application/json​
Host: kafka.volcengineapi.com​
X-Date: 20210328T100802Z​
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-beijing/Kafka/request, SignedHeaders=x-date, Signature=********​
​
{​
    "RegionId": "cn-beijing"​
}​

Response example

{​
    "ResponseMetadata": {​
        "RequestId": "20230227162855CD78212B545D4168BA43",​
        "Action": "DescribeAvailabilityZones",​
        "Version": "2022-05-01",​
        "Service": "Kafka",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "RegionId": "cn-beijing",​
        "Zones": [​
            {​
                "Description": "Availability Zone A",​
                "Status": "Normal",​
                "ZoneId": "cn-beijing-a",​
                "ZoneName": "cn-beijing-a"​
            },​
            {​
                "Description": "Availability Zone B",​
                "Status": "Normal",​
                "ZoneId": "cn-beijing-b",​
                "ZoneName": "cn-beijing-b"​
            }​
        ]​
    }​
}​

Error code

The following table lists error codes related to this interface and business logic. Refer to the Public error codes section for common error codes.

Status code	Error code	Error message	Specifications
400	InvalidParameter.Unsupported	The specified parameter %s is not supported.	Parameter %s is not supported.
400	InvalidParameter.Malformed	The specified parameter %s is Malformed.	%s parameter does not meet the specification.
400	Forbidden.Authentication	This operation is forbidden by Realname Authentication system.	The account is not verified.
500	InternalError	The request failed due to some unknown error, exception or failure.	Internal error, please try again later.

Last updated: 2025.10.15 10:11:19