Help & DocumentationCloud Virtual MachineAPI DocumentationRegion APIsDescribeZones

DescribeZones

Last updated: 2020-04-03 11:28:14

PDF

1. API Description

Domain name for API request: cvm.tencentcloudapi.com.

This API is used to query availability zones.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cvm.ap-shanghai-fsi.tencentcloudapi.com

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeZones.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of availability zones.
ZoneSet Array of ZoneInfo List of availability zones.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying availability zones in a region

This example shows you how to query availability zones in the Guangzhou region.

Input Example

GET https://cvm.tencentcloudapi.com/?Action=DescribeZones
&<Common request parameter>

Output Example

{
  "Response": {
    "TotalCount": 4,
    "ZoneSet": [
      {
        "ZoneState": "UNAVAILABLE",
        "ZoneId": "100001",
        "Zone": "ap-guangzhou-1",
        "ZoneName": "Guangzhou Zone 1"
      },
      {
        "ZoneState": "AVAILABLE",
        "ZoneId": "100002",
        "Zone": "ap-guangzhou-2",
        "ZoneName": "Guangzhou Zone 2"
      },
      {
        "ZoneState": "AVAILABLE",
        "ZoneId": "100003",
        "Zone": "ap-guangzhou-3",
        "ZoneName": "Guangzhou Zone 3"
      },
      {
        "ZoneState": "AVAILABLE",
        "ZoneId": "100004",
        "Zone": "ap-guangzhou-4",
        "ZoneName": "Guangzhou Zone 4"
      }
    ],
    "RequestId": "62DDFFC6-FDB5-44F7-20A6-59152E3D129A"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.