tencent cloud

Feedback

DescribeZones

Last updated: 2022-09-26 17:00:14

1. API Description

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

This API is used to query the list of AZs in a region.

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

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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 Params. The value used for this API: DescribeZones.
Version Yes String Common Params. The value used for this API: 2020-03-24.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
OrderField No String Sorting field. Valid values:
  • ZONE: Sort by the availability zone.
  • INSTANCE_DISPLAY_LABEL: Sort by visibility labels (HIDDEN, NORMAL and SELECTED). Default: ['HIDDEN', 'NORMAL', 'SELECTED'].
    The default value is ZONE.
  • Order No String Specifies how availability zones are listed. Valid values:
  • ASC: Ascending sort.
  • DESC: Descending sort.
    The default value is ASC.
  • 3. Output Parameters

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

    4. Example

    Example1 Querying AZs

    Input Example

    POST / HTTP/1.1
    Host: lighthouse.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeZones
    <Common request parameters>
    
    {}
    

    Output Example

    {
        "Response": {
            "ZoneInfoSet": [
                {
                    "Zone": "ap-guangzhou-2",
                    "ZoneName": "Guangzhou Zone 2",
                    "InstanceDisplayLabel": "NORMAL"
                },
                {
                    "Zone": "ap-guangzhou-3",
                    "ZoneName": "Guangzhou Zone 3",
                    "InstanceDisplayLabel": "NORMAL"
                },
                {
                    "Zone": "ap-guangzhou-4",
                    "ZoneName": "Guangzhou Zone 4",
                    "InstanceDisplayLabel": "NORMAL"
                }
            ],
            "TotalCount": 3,
            "RequestId": "5e1bf334-e530-4c26-ab92-d911ab148d3a"
        }
    }
    

    5. Developer Resources

    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

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    InternalError.InvalidCommandNotFound The command DescribeInstanceLoginKeyPair could not be found.
    InvalidParameterValue Incorrect parameter value.
    UnknownParameter Unknown parameter error.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support