tencent cloud



Last updated: 2022-10-11 11:24:01

1. API Description

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

This API is used to query CLB instances bound to the CVM or ENI.

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: DescribeLBListeners.
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.
Backends.N Yes Array of LbRsItem List of private network IPs to be queried.

3. Output Parameters

Parameter Name Type Description
LoadBalancers Array of LBItem Listener rule associated with the real server.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying CLB instances bound to the CVM

Input Example

&<Common request parameters>

Output Example

    "Response": {
        "LoadBalancers": [
                "LoadBalancerId": "lb-xxxxx",
                "Vip": "",
                "Region": "ap-guangzhou",
                "Listeners": [
                        "ListenerId": "lbl-xxxxx",
                        "Protocol": "TCP",
                        "Port": 81,
                        "EndPort": 0,
                        "Rules": null,
                        "Targets": [
                                "Type": "eni",
                                "PrivateIp": "",
                                "Port": 1201,
                                "VpcId": 1111,
                                "Weight": 10
        "RequestId": "83129908-a282-4f9f-8ab-131a3025ba22"

5. Developer Resources


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.
InvalidParameter.LBIdNotFound Wrong CLB instance ID.
InvalidParameter.ListenerIdNotFound Wrong listener ID.
InvalidParameterValue.Length Wrong parameter length.
LimitExceeded Quota exceeded.
MissingParameter Missing parameter.
UnauthorizedOperation Unauthorized operation.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support