有奖捉虫:办公协同&微信生态&物联网文档专题 HOT
文档中心 > 负载均衡 > API 文档 > 其他相关接口 > 查询用户在当前地域支持可用区列表和资源列表

1. 接口描述

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

查询用户在当前地域支持可用区列表和资源列表。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeResources。
Version String 公共参数,本接口取值:2018-03-17。
Region String 公共参数,详见产品支持的 地域列表
Limit Integer 返回可用区资源列表数目,默认20,最大值100。
示例值:20
Offset Integer 返回可用区资源列表起始偏移量,默认0。
示例值:0
Filters.N Array of Filter 查询可用区资源列表条件,详细的过滤条件如下:
  • master-zone -- String - 是否必填:否 - (过滤条件)按照 地区 类型过滤,如:"ap-guangzhou-2"。
  • ip-version -- String - 是否必填:否 - (过滤条件)按照 IP 类型过滤,可选值:"IPv4"、"IPv6"、"IPv6_Nat"。
  • isp -- String - 是否必填:否 - (过滤条件)按照 Isp 类型过滤,如:"BGP","CMCC","CUCC","CTCC"。
  • 3. 输出参数

    参数名称 类型 描述
    ZoneResourceSet Array of ZoneResource 可用区支持的资源列表。
    TotalCount Integer 可用区资源列表数目。
    示例值:3
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询用户在当前地域支持可用区列表和资源列表

    查询用户在当前地域支持可用区列表和资源列表

    输入示例

    POST / HTTP/1.1
    Host: clb.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeResources
    <公共请求参数>
    
    {
        "Limit": "20",
        "Offset": "0"
    }

    输出示例

    {
        "Response": {
            "ZoneResourceSet": [
                {
                    "MasterZone": "ap-guangzhou",
                    "SlaveZone": null,
                    "IPVersion": "IPv6",
                    "ResourceSet": [
                        {
                            "Isp": "BGP",
                            "Type": [
                                "BGP"
                            ],
                            "TypeSet": [],
                            "AvailabilitySet": []
                        }
                    ],
                    "ZoneRegion": "ap-guangzhou",
                    "LocalZone": false,
                    "EdgeZone": false,
                    "ZoneResourceType": "SHARED",
                    "Egress": "center_egress1"
                },
                {
                    "MasterZone": "ap-guangzhou",
                    "SlaveZone": null,
                    "IPVersion": "IPv6_Nat",
                    "ResourceSet": [
                        {
                            "Isp": "BGP",
                            "Type": [
                                "BGP"
                            ],
                            "TypeSet": [],
                            "AvailabilitySet": []
                        }
                    ],
                    "ZoneRegion": "ap-guangzhou",
                    "LocalZone": false,
                    "EdgeZone": false,
                    "ZoneResourceType": "SHARED",
                    "Egress": "center_egress1"
                },
                {
                    "MasterZone": "ap-guangzhou-2",
                    "SlaveZone": null,
                    "IPVersion": "IPv4",
                    "ResourceSet": [
                        {
                            "Isp": "BGP",
                            "Type": [
                                "BGP"
                            ],
                            "TypeSet": [],
                            "AvailabilitySet": []
                        },
                        {
                            "Isp": "INTERNAL",
                            "Type": [
                                "INTERNAL"
                            ],
                            "TypeSet": [],
                            "AvailabilitySet": []
                        }
                    ],
                    "ZoneRegion": "ap-guangzhou",
                    "LocalZone": false,
                    "EdgeZone": false,
                    "ZoneResourceType": "SHARED",
                    "Egress": "center_egress1"
                }
            ],
            "TotalCount": 3,
            "RequestId": "e0d11bcf-c3fa-45b8-b438-a4b642dbaad6"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    FailedOperation 操作失败。
    InternalError 内部错误。
    InvalidParameter 参数错误。
    InvalidParameter.FormatError 参数格式错误。
    InvalidParameterValue 参数取值错误。
    InvalidParameterValue.Duplicate 参数值有重复。
    InvalidParameterValue.InvalidFilter Filter参数输入错误。
    InvalidParameterValue.Length 参数长度错误。
    InvalidParameterValue.Range 参数取值范围错误。