tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeLoadBalancersDetail

Last updated: 2024-09-05 19:29:56

    1. API Description

    Domain name for API request: clb.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 No String Common Params. This parameter is not required for this API.
    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 should select exporting the Target of the target group or a non-target group. Valid values: NODE, GROUP.
    Filters.N No Array of Filter Filter condition of querying lists describing CLB instance details:
  • loadbalancer-id - String - Required: no - (Filter condition) CLB instance ID, such as "lb-12345678".
  • project-id - String - Required: no - (Filter condition) Project ID, such as "0" and "123".
  • network - String - Required: no - (Filter condition) Network type of the CLB instance, such as "Public" and "Private".
  • vip - String - Required: no - (Filter condition) CLB instance VIP, such as "1.1.1.1" and "2204::22:3".
  • target-ip - String - Required: no - (Filter condition) Private IP of the target real servers, such as"1.1.1.1" and "2203::214:4".
  • vpcid - String - Required: no - (Filter condition) Identifier of the VPC instance to which the CLB instance belongs, such as "vpc-12345678".
  • zone - String - Required: no - (Filter condition) Availability zone where the CLB instance resides, such as "ap-guangzhou-1".
  • tag-key - String - Required: no - (Filter condition) Tag key of the CLB instance, such as "name".
  • tag:* - String - Required: no - (Filter condition) CLB instance tag, followed by tag key after the colon ':'. For example, use {"Name": "tag:name","Values": ["zhangsan", "lisi"]} to filter the tag key “name” with the tag value “zhangsan” and “lisi”.
  • fuzzy-search - String - Required: no - (Filter condition) Fuzzy search for CLB instance VIP and CLB instance name, such as "1.1".
    		•

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number of lists describing CLB instance details.
    LoadBalancerDetailSet Array of LoadBalancerDetail List of CLB instance details.
    Note: this field may return null, indicating that no valid values can be obtained.
    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.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLoadBalancersDetail
<Common request parameters>



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

    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 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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy