Release Notes and Announcements

CLB Release Notes

Product Announcements

Product Introduction

Overview

Strengths

Use Cases

Principles

Product Comparison

Use Limits

Service Regions and Service Providers

Purchase Guide

Billing Overview

Billing

CLB Resource Package

Purchase Methods

Payment Overdue

Product Attribute Selection

Getting Started

Getting Started with Domain Name-Based CLB

Getting Started with CLB

Getting Started with IPv6 CLB

Deploying Nginx on CentOS

Deploying Java Web on CentOS

Operation Guide

CLB Instance

CLB Listener

Real Server

Health Check

Certificate Management

Log Management

Monitoring and Alarm

Cloud Access Management

Classic CLB

Practical Tutorial

Deploy certificate to CLB (mutual authentication)

Enabling Gzip Compression & Testing

HTTPS Forwarding Configurations

Obtaining Real Client IPs

Best Practices for Configuring Load Balancing Monitoring Alerts

Implementing HA Across Multiple AZs

Load Balancing Algorithm Selection and Weight Configuration Examples

Configuring WAF protection for CLB listening domain names

Configure IAP to authenticate web access to the CLB domain and path

Configure IAP to authenticate programmatic access to CLB's domain and path

Ops Guide

Solution to Excessive Clients in TIME_WAIT Status

Load Balancer HTTPS Service Performance Test

Stress Testing FAQ

CLB Certificate Operation Permissions

Troubleshooting

UDP Health Check Exception

API Documentation

History

Introduction

API Category

Instance APIs

Listener APIs

Backend Service APIs

Target Group APIs

Redirection APIs

Other APIs

Classic CLB APIs

Load Balancing APIs

Making API Requests

Data Types

Error Codes

CLB API 2017

FAQs

Billing

CLB Configuration

Troubleshooting Health Check Issues

HTTPS

WS/WSS Protocol Support

HTTP/2 Protocol Support

Default Domain Name Blocking Prompt

Service Level Agreement

Glossary

DescribeLoadBalancersDetail

PDF

Focus Mode

Font Size

Last updated: 2026-01-13 21:46:43

1. API Description

Domain name for API request: clb.intl.tencentcloudapi.com.

This API is used to query CLB instance details, including listener, rules, and target real servers.

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: DescribeLoadBalancersDetail.
Version	Yes	String	Common Params. The value used for this API: 2018-03-17.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
Limit	No	Integer	Number of CLB instance lists returned. Default value: 20; maximum value: 100.
Offset	No	Integer	Starting offset of the CLB instance list returned. Default value: 0.
Fields.N	No	Array of String	List of fields. Only fields specified will be returned. If it’s left blank, `null` is returned. The fields `LoadBalancerId` and `LoadBalancerName` are added by default. For details about fields, see LoadBalancerDetail.
TargetType	No	String	When the Fields include TargetId, TargetAddress, TargetPort, TargetWeight, ListenerId, Protocol, Port, LocationId, Domain, and Url, you must select exporting the Target of the Target GROUP or a non-Target GROUP. valid values: NODE, GROUP.
Filters.N	No	Array of Filter	Querying conditions for cloud load balancer detailed information list. detailed filter criteria. - loadbalancer-id Filter by [clb ID], for example: lb-rbw5skde. Type: String. Required: No Method for obtaining: DescribeLoadBalancers. - project-id Filters by [project ID]. for example: "0", "123". Type: String. Required: No Method for obtaining: DescribeProject. - network Filters by [clb network type]. for example: Public. Type: String. Required: No Valid values: Private (Private network), Public (Public network). - vip Filter by [cloud load balancer VIP], such as "1.1.1.1", "2204::22:3". Type: String. Required: No - vpcid Filter by the vpc to which the cloud load balancer belongs, such as "vpc-12345678". Type: String. Required: No Method for obtaining: DescribeZones. - target-ip Filters by the private network IP of the backend destination. for example: "1.1.1.1", "2203::214:4". Type: String. Required: No - zone Filter by [availability zone of the cloud load balancer]. for example: "ap-guangzhou-1". Type: String. Required: No Method for obtaining: DescribeZones. - tag-key Filters by [tag key of the cloud load balancer tag], for example: "name". Type: String. Required: No Method for obtaining: DescribeTags. - tag:* Filter by [cloud load balancer tag], where ':' is followed by the tag key. for example, to filter by tag key 'name' with tag Values 'zhangsan' and 'lisi', use {"name": "tag:name","Values": ["zhangsan", "lisi"]}. Type: String. Required: No Method for obtaining: DescribeTagKeys. - fuzzy-search Searches by [clb VIP, clb name] using fuzzy search, for example: "1.1". Type: String. Required: No

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number of lists describing CLB instance details.
LoadBalancerDetailSet	Array of LoadBalancerDetail	Load balancing detail list.
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 CLB Instance Details

Input Example

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

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

Output Example

{
    "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. 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

Tencent Cloud CLI 3.0

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	Internal error.
InvalidParameter	Parameter error.
InvalidParameter.FormatError	Wrong parameter format.
InvalidParameterValue	Incorrect parameter value.
InvalidParameterValue.InvalidFilter	Incorrect `Filter` parameter.
InvalidParameterValue.Length	Wrong parameter length.
InvalidParameterValue.Range	Wrong parameter value range.
UnauthorizedOperation	Unauthorized operation.

Help and Support

Was this page helpful?

You can also Contact sales or Submit a Ticket for help.

Help us improve! Rate your documentation experience in 5 mins.

Feedback

tencent cloud

Cloud Load Balancer