tencent cloud

APIs

文档APIsCloud Load BalancerInstance APIsDescribeLoadBalancersDetail

DescribeLoadBalancersDetail

下载
聚焦模式
字号
最后更新时间： 2026-06-17 17:21:38

1. API Description

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

Query the detailed information of Cloud Load Balancer, including listeners, rules, and backend targets.

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: 2023-04-17.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
Limit No Integer Return the number of Cloud Load Balancer (CLB) lists. Default is 20. Maximum value is 100.
Offset No Integer Starting offset for returning the list of CLB instances, with a default value of 0.
Fields.N No Array of String Select the Fields list to return. The system will only return the Fields filled in Fields. For fillable field details, see LoadBalancerDetail. If a related field is not in Fields, this field returns null. The LoadBalancerId and LoadBalancerName Fields are added by default in Fields.
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 Query the detailed information list of Cloud Load Balancer. Detailed filter criteria:
  • loadbalancer-id - String - Required: No - (Filter condition) Filter by CLB ID, for example: "lb-12345678".
  • project-id - String - Required: No - (Filter condition) Filter by project ID, for example: "0", "123".
  • network - String - Required: No - (Filter condition) Filter by CLB network type, such as "Public" or "Private".
  • vip - String - Required: No - (Filter condition) Filter by CLB vip, for example: "1.1.1.1", "2204::22:3".
  • target-ip - String - Required: No - (Filtering Conditions) Filter by private ip of the target real server, such as "1.1.1.1", "2203::214:4".
  • vpcid - String - Required: No - (Filter condition) Filter by the associated vpc ID of the Cloud Load Balancer (CLB), such as "vpc-12345678".
  • zone - String - Required: No - (Filtering Conditions) Filter by the availability zone the load balancing belongs to, such as "ap-guangzhou-1".
  • tag-key - String - required: no - (filter condition) filter by tag key of Cloud Load Balancer, such as "name".
  • tag:* - String - Required: No - (Filter criteria) Filter by the tag of Cloud Load Balancer (CLB), where ':' is followed by the tag key. For example, to filter by tag key 'name' and tag values 'zhangsan' and 'lisi', use {"Name": "tag:name","Values": ["zhangsan", "lisi"]}.
  • fuzzy-search - String - required: no - (filter condition) fuzzy search by CLB Vip and CLB name, for example: "1.1".
    		•

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number of items in CLB detail list.
    LoadBalancerDetailSet Array of LoadBalancerDetail Cloud Load Balancer 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

    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": "20",
    "Offset": "0"
}

    Output Example

    {
    "Response": {
        "TotalCount": 0,
        "LoadBalancerDetailSet": [],
        "RequestId": "d09b91ba-a81e-4ca3-b423-c64e60127c64"
    }
}

    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

    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 Incorrect parameter format.
    InvalidParameterValue Parameter value error.
    InvalidParameterValue.InvalidFilter Filter parameter input error.
    InvalidParameterValue.Length Invalid parameter length.
    InvalidParameterValue.Range Invalid parameter value range.
    UnauthorizedOperation Unauthorized operation.
    上一篇: CloneLoadBalancer下一篇: DescribeLoadBalancers

    帮助和支持

    本页内容是否解决了您的问题？

    填写满意度调查问卷，共创更好文档体验。

    文档反馈