tencent cloud

Tencent Cloud Lighthouse

문서Tencent Cloud LighthouseAPI DocumentationRegion APIsDescribeZones

DescribeZones

PDF
포커스 모드
폰트 크기
마지막 업데이트 시간: 2025-10-30 21:47:13

1. API Description

Domain name for API request: lighthouse.intl.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. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
OrderField No String Field on which the AZ list is sorted. value range:.
  • ZONE: sorted based on availability zone.
    • .
    INSTANCE_DISPLAY_LABEL: specifies the Tag DISPLAY sorting order based on availability zone. valid values: HIDDEN (hide), NORMAL (ordinary), SELECTED (chosen by default). defaults to ascending order: ['HIDDEN', 'NORMAL', 'SELECTED'].
    Specifies the default sorting order by availability zone.
    Order No String Outputs the sorting order of the availability zone list. value range:.
  • ASC: ascending order.
    • .
  • DESC: sort in descending order.
    • .
    Specifies the default ascending order.

    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, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Querying Availability Zones

    Input Example

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

{}

    Output Example

    {
    "Response": {
        "ZoneInfoSet": [
            {
                "Zone": "ap-guangzhou-3",
                "ZoneName": "Guangzhou Zone 3",
                "InstanceDisplayLabel": "NORMAL"
            },
            {
                "Zone": "ap-guangzhou-4",
                "ZoneName": "Guangzhou Zone 4",
                "InstanceDisplayLabel": "NORMAL"
            }
        ],
        "TotalCount": 2,
        "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
    FailedOperation Operation failed.
    InternalError.InvalidCommandNotFound The command is not found.
    InvalidParameterValue Incorrect parameter value.
    UnknownParameter Unknown parameter error.
    이전 주제: DescribeRegions다음 주제: Data Types

    도움말 및 지원

    문제 해결에 도움이 되었나요?

    피드백