操作指南

API 文档

填写文档满意度调查问卷,赢取缤纷好礼> HOT

查询可用区列表

最近更新时间:2022-06-01 06:13:10

我的收藏

1. 接口描述

接口请求域名: lighthouse.tencentcloudapi.com 。

查询地域下可用区

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeZones。
Version String 公共参数,本接口取值:2020-03-24。
Region String 公共参数,详见产品支持的 地域列表
OrderField String 可用区列表排序的依据字段。取值范围:
  • ZONE:依据可用区排序。
  • INSTANCE_DISPLAY_LABEL:依据可用区展示标签排序,可用区展示标签包括:HIDDEN(隐藏)、NORMAL(普通)、SELECTED(默认选中),默认采用的升序排列为:['HIDDEN', 'NORMAL', 'SELECTED']。
    默认按可用区排序。
  • Order String 输出可用区列表的排列顺序。取值范围:
  • ASC:升序排列。
  • DESC:降序排列。
    默认按升序排列。
  • 3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 可用区数量
    ZoneInfoSet Array of ZoneInfo 可用区详细信息列表
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询可用区

    输入示例

    POST / HTTP/1.1
    Host: lighthouse.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeZones
    <公共请求参数>
    
    {}

    输出示例

    {
      "Response": {
        "ZoneInfoSet": [
          {
            "Zone": "ap-guangzhou-2",
            "ZoneName": "广州二区",
            "InstanceDisplayLabel": "NORMAL"
          },
          {
            "Zone": "ap-guangzhou-3",
            "ZoneName": "广州三区",
            "InstanceDisplayLabel": "NORMAL"
          },
          {
            "Zone": "ap-guangzhou-4",
            "ZoneName": "广州四区",
            "InstanceDisplayLabel": "NORMAL"
          }
        ],
        "TotalCount": 3,
        "RequestId": "5e1bf334-e530-4c26-ab92-d911ab148d3a"
      }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    InternalError.InvalidCommandNotFound 命令 DescribeInstanceLoginKeyPair 无法找到。
    InvalidParameterValue 参数取值错误。
    UnknownParameter 未知参数错误。
    目录