负载均衡
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 负载均衡 > API 文档 > 其他相关接口 > 查询集群列表

查询集群列表

最近更新时间：2024-03-12 19:50:27

我的收藏

本页目录：

1. 接口描述

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

查询集群信息列表，支持以集群类型、集群唯一ID、集群名字、集群标签、集群内vip、集群内负载均衡唯一id、集群网络类型、可用区等条件进行检索

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeExclusiveClusters。
Version 是 String 公共参数，本接口取值：2018-03-17。
Region 是 String 公共参数，详见产品支持的 地域列表。
Limit 否 Integer 返回集群列表数目，默认值为20，最大值为100。
示例值：20
Offset 否 Integer 返回集群列表起始偏移量，默认为0。
示例值：0
Filters.N 否 Array of Filter 查询集群列表条件，详细的过滤条件如下：
  • cluster-type - String - 是否必填：否 - （过滤条件）按照 集群 的类型过滤，包括"TGW","STGW","VPCGW"。
  • cluster-id - String - 是否必填：否 - （过滤条件）按照 集群 的唯一ID过滤，如 ："tgw-12345678","stgw-12345678","vpcgw-12345678"。
  • cluster-name - String - 是否必填：否 - （过滤条件）按照 集群 的名称过滤。
  • cluster-tag - String - 是否必填：否 - （过滤条件）按照 集群 的标签过滤。（只有TGW/STGW集群有集群标签）
  • vip - String - 是否必填：否 - （过滤条件）按照 集群 内的vip过滤。
  • loadblancer-id - String - 是否必填：否 - （过滤条件）按照 集群 内的负载均衡唯一ID过滤。
  • network - String - 是否必填：否 - （过滤条件）按照 集群 的网络类型过滤，如："Public","Private"。
  • zone - String - 是否必填：否 - （过滤条件）按照 集群 所在可用区过滤，如："ap-guangzhou-1"（广州一区）。
  • isp -- String - 是否必填：否 - （过滤条件）按照TGW集群的 Isp 类型过滤，如："BGP","CMCC","CUCC","CTCC","INTERNAL"。
    		•

    3. 输出参数

    参数名称 类型 描述
    ClusterSet Array of Cluster 集群列表。
    TotalCount Integer 集群总数量。
    示例值：1
    RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询集群列表

    输入示例

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

{
    "Limit": "20",
    "Offset": "0"
}

    输出示例

    {
    "Response": {
        "TotalCount": 1,
        "ClusterSet": [
            {
                "ClustersVersion": "",
                "ClusterId": "tgw-12345678",
                "ClusterName": "tgw_cluster",
                "ClusterType": "TGW",
                "ClusterTag": null,
                "Zone": "ap-guangzhou-1",
                "Network": "Public",
                "Isp": "CMCC",
                "MaxConn": 12,
                "MaxInFlow": 0,
                "MaxInPkg": 0,
                "MaxOutFlow": 0,
                "MaxOutPkg": 0,
                "MaxNewConn": 0,
                "HTTPMaxNewConn": 0,
                "HTTPSMaxNewConn": 0,
                "HTTPQps": 0,
                "HTTPSQps": 0,
                "ClustersZone": {
                    "MasterZone": [
                        "ap-hongkong-1"
                    ],
                    "SlaveZone": [
                        "ap-hongkong-2"
                    ]
                },
                "ResourceCount": 30,
                "IdleResourceCount": 26,
                "LoadBalanceDirectorCount": 4,
                "DisasterRecoveryType": "DISASTER-RECOVERY",
                "Egress": "abc",
                "IPVersion": "abc"
            }
        ],
        "RequestId": "49e44bf9-1357-420b-87ba-3c827209af67"
    }
}

    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 参数取值范围错误。
    中国站