负载均衡查询负载均衡详细信息

1. 接口描述

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

查询负载均衡的详细信息，包括监听器，规则及后端目标。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeLoadBalancersDetail。
Version	是	String	公共参数，本接口取值：2018-03-17。
Region	是	String	公共参数，详见产品支持的地域列表。
Limit	否	Integer	返回负载均衡列表数目，默认20，最大值100。示例值：20
Offset	否	Integer	返回负载均衡列表起始偏移量，默认0。示例值：0
Fields.N	否	Array of String	选择返回的Fields列表，系统仅会返回Fileds中填写的字段，可填写的字段详情请参见LoadBalancerDetail。若未在Fileds填写相关字段，则此字段返回null。Fileds中默认添加LoadBalancerId和LoadBalancerName字段。示例值：["LoadBalancerId","LoadBalancerName"]
TargetType	否	String	当Fields包含TargetId、TargetAddress、TargetPort、TargetWeight、ListenerId、Protocol、Port、LocationId、Domain、Url等Fields时，必选选择导出目标组的Target或者非目标组Target，取值范围NODE、GROUP。示例值：NODE
Filters.N	否	Array of Filter	查询负载均衡详细信息列表条件，详细的过滤条件如下： - loadbalancer-id 按照【负载均衡ID】进行过滤。例如：lb-rbw5skde。类型：String 必选：否获取方式：DescribeLoadBalancers - project-id 按照【项目ID】进行过滤。例如： "0"、"123"。类型：String 必选：否获取方式：DescribeProject - network 按照【负载均衡网络类型】进行过滤。例如：Public。类型：String 必选：否可选值：Private（内网）、Public（公网） - vip 按照【负载均衡 VIP】进行过滤。例如："1.1.1.1","2204::22:3"。类型：String 必选：否 - vpcid 按照【负载均衡所属 VPCID】进行过滤。例如："vpc-12345678"。类型：String 必选：否获取方式：DescribeZones - target-ip 按照【后端目标内网 IP】进行过滤。例如："1.1.1.1","2203::214:4"。类型：String 必选：否 - zone 按照【负载均衡所属的可用区】进行过滤。例如："ap-guangzhou-1"。类型：String 必选：否获取方式：DescribeZones - tag-key 按照【负载均衡标签的标签键】进行过滤，例如："name"。类型：String 必选：否获取方式：DescribeTags - tag:* 按照【负载均衡的标签】进行过滤，':' 后面跟的是标签键。如过滤标签键name，标签值zhangsan,lisi，{"Name": "tag:name","Values": ["zhangsan", "lisi"]}。类型：String 必选：否获取方式：DescribeTagKeys - fuzzy-search 按照【负载均衡VIP，负载均衡名称】模糊搜索，例如："1.1"。类型：String 必选：否

3. 输出参数

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

4. 示例

示例1 查询负载均衡详细信息

输入示例

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

{
    "Limit": 2,
    "Offset": 5
}

输出示例

{
    "Response": {
        "LoadBalancerDetailSet": [
            {
                "LoadBalancerId": "lb-42ua7vc4",
                "LoadBalancerName": "lb-65e19dc1-Swzo",
                "LoadBalancerDomain": "lb-42ua7vc4-*****8.clb.ap-guangzhou.com",
                "Status": 1,
                "Isolation": 0,
                "Address": null,
                "AddressIPv6": null,
                "AddressIPVersion": "IPv4",
                "IPv6Mode": null,
                "Zone": "ap-guangzhou-2",
                "Zones": null,
                "SlaveZone": null,
                "LoadBalancerType": "Public",
                "AddressIsp": null,
                "VpcId": "vpc-1yxy51wh",
                "ChargeType": "POSTPAID_BY_HOUR",
                "NetworkAttributes": {
                    "InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
                    "InternetMaxBandwidthOut": 6,
                    "BandwidthpkgSubType": null
                },
                "PrepaidAttributes": null,
                "ProjectId": 0,
                "SecurityGroup": null,
                "LoadBalancerPassToTarget": 0,
                "Tags": null,
                "ExtraInfo": null,
                "ConfigId": null,
                "CreateTime": "2024-03-05 22:08:01",
                "ListenerId": null,
                "Protocol": null,
                "Port": null,
                "SniSwitch": null,
                "LocationId": null,
                "Domain": null,
                "Domains": null,
                "Url": null,
                "TargetId": null,
                "TargetAddress": null,
                "TargetPort": null,
                "TargetWeight": null,
                "TargetHealth": null,
                "Egress": ""
            },
            {
                "LoadBalancerId": "lb-5e5gta0w",
                "LoadBalancerName": "lb-65e19e54-4rzS",
                "LoadBalancerDomain": "lb-5e5gta0w-*******.clb.ap-guangzhou.com",
                "Status": 1,
                "Isolation": 0,
                "Address": null,
                "AddressIPv6": null,
                "AddressIPVersion": "IPv4",
                "IPv6Mode": null,
                "Zone": "ap-guangzhou-2",
                "Zones": null,
                "SlaveZone": null,
                "LoadBalancerType": "Public",
                "AddressIsp": null,
                "VpcId": "vpc-1yxy51wh",
                "ChargeType": "POSTPAID_BY_HOUR",
                "NetworkAttributes": {
                    "InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
                    "InternetMaxBandwidthOut": 6,
                    "BandwidthpkgSubType": null
                },
                "PrepaidAttributes": null,
                "ProjectId": 0,
                "SecurityGroup": null,
                "LoadBalancerPassToTarget": 0,
                "Tags": null,
                "ExtraInfo": null,
                "ConfigId": null,
                "CreateTime": "2024-03-05 22:10:28",
                "ListenerId": null,
                "Protocol": null,
                "Port": null,
                "SniSwitch": null,
                "LocationId": null,
                "Domain": null,
                "Domains": null,
                "Url": null,
                "TargetId": null,
                "TargetAddress": null,
                "TargetPort": null,
                "TargetWeight": null,
                "TargetHealth": null,
                "Egress": ""
            },
            {
                "LoadBalancerId": "lb-7pqspi5i",
                "LoadBalancerName": "lb-65e19f3e-R6qu",
                "LoadBalancerDomain": "lb-7pqspi5i-********.clb.ap-guangzhou..com",
                "Status": 1,
                "Isolation": 0,
                "Address": null,
                "AddressIPv6": null,
                "AddressIPVersion": "IPv4",
                "IPv6Mode": null,
                "Zone": "ap-guangzhou-2",
                "Zones": null,
                "SlaveZone": null,
                "LoadBalancerType": "Public",
                "AddressIsp": null,
                "VpcId": "vpc-1yxy51wh",
                "ChargeType": "POSTPAID_BY_HOUR",
                "NetworkAttributes": {
                    "InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
                    "InternetMaxBandwidthOut": 6,
                    "BandwidthpkgSubType": null
                },
                "PrepaidAttributes": null,
                "ProjectId": 0,
                "SecurityGroup": null,
                "LoadBalancerPassToTarget": 0,
                "Tags": null,
                "ExtraInfo": null,
                "ConfigId": null,
                "CreateTime": "2024-03-05 22:14:23",
                "ListenerId": null,
                "Protocol": null,
                "Port": null,
                "SniSwitch": null,
                "LocationId": null,
                "Domain": null,
                "Domains": null,
                "Url": null,
                "TargetId": null,
                "TargetAddress": null,
                "TargetPort": null,
                "TargetWeight": null,
                "TargetHealth": null,
                "Egress": ""
            },
            {
                "LoadBalancerId": "lb-av9bugwy",
                "LoadBalancerName": "lb-65e19f53-HOij",
                "LoadBalancerDomain": "lb-av9bugwy-*****.clb.ap-guangzhou.com",
                "Status": 1,
                "Isolation": 0,
                "Address": null,
                "AddressIPv6": null,
                "AddressIPVersion": "IPv4",
                "IPv6Mode": null,
                "Zone": "ap-guangzhou-2",
                "Zones": null,
                "SlaveZone": null,
                "LoadBalancerType": "Public",
                "AddressIsp": null,
                "VpcId": "vpc-1yxy51wh",
                "ChargeType": "POSTPAID_BY_HOUR",
                "NetworkAttributes": {
                    "InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
                    "InternetMaxBandwidthOut": 6,
                    "BandwidthpkgSubType": null
                },
                "PrepaidAttributes": null,
                "ProjectId": 0,
                "SecurityGroup": null,
                "LoadBalancerPassToTarget": 0,
                "Tags": null,
                "ExtraInfo": null,
                "ConfigId": null,
                "CreateTime": "2024-03-05 22:14:45",
                "ListenerId": null,
                "Protocol": null,
                "Port": null,
                "SniSwitch": null,
                "LocationId": null,
                "Domain": null,
                "Domains": null,
                "Url": null,
                "TargetId": null,
                "TargetAddress": null,
                "TargetPort": null,
                "TargetWeight": null,
                "TargetHealth": null,
                "Egress": ""
            },
            {
                "LoadBalancerId": "lb-0s4e1oww",
                "LoadBalancerName": "lb-65e5692e-a8pT",
                "LoadBalancerDomain": "lb-0s4e1oww-*********.clb.ap-guangzhou.com",
                "Status": 1,
                "Isolation": 0,
                "Address": null,
                "AddressIPv6": null,
                "AddressIPVersion": "IPv4",
                "IPv6Mode": null,
                "Zone": "ap-guangzhou-2",
                "Zones": null,
                "SlaveZone": null,
                "LoadBalancerType": "Public",
                "AddressIsp": null,
                "VpcId": "vpc-1yxy51wh",
                "ChargeType": "POSTPAID_BY_HOUR",
                "NetworkAttributes": {
                    "InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
                    "InternetMaxBandwidthOut": 5,
                    "BandwidthpkgSubType": null
                },
                "PrepaidAttributes": null,
                "ProjectId": 0,
                "SecurityGroup": null,
                "LoadBalancerPassToTarget": 0,
                "Tags": null,
                "ExtraInfo": null,
                "ConfigId": null,
                "CreateTime": "2024-03-05 19:12:19",
                "ListenerId": null,
                "Protocol": null,
                "Port": null,
                "SniSwitch": null,
                "LocationId": null,
                "Domain": null,
                "Domains": null,
                "Url": null,
                "TargetId": null,
                "TargetAddress": null,
                "TargetPort": null,
                "TargetWeight": null,
                "TargetHealth": null,
                "Egress": ""
            }
        ],
        "TotalCount": 16,
        "RequestId": "1626ec6f-f87e-476c-a9f3-ac3a87a5f3e6"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

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

查询负载均衡详细信息

本页目录：