tencent cloud

All product documents
APIs
DocumentationAPIsCloud Load BalancerLoad Balancing APIsDescribeIdleLoadBalancers
DescribeIdleLoadBalancers
Last updated: 2024-09-05 19:29:49
DescribeIdleLoadBalancers
Last updated: 2024-09-05 19:29:49

1. API Description

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

Idle CLB instances are pay-as-you-go load balancers that, within seven days after the creation, do not have rules configured or the configured rules are not associated with any 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: DescribeIdleLoadBalancers.
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.
Offset No Integer Data offset. Default value: 0.
Limit No Integer Number of returned CLB instances. Default value: 20. Maximum value: 100.
LoadBalancerRegion No String CLB instance region

3. Output Parameters

Parameter Name Type Description
IdleLoadBalancers Array of IdleLoadBalancer List of idle CLBs
Note: This field may return null, indicating that no valid values can be obtained.
TotalCount Integer Total number of idle CLB instances
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 list of idle CLB instances

Input Example

https://clb.tencentcloudapi.com/?Action=DescribeIdleLoadBalancers
&<Common request parameters>

Output Example

{
    "Response": {
        "TotalCount": 46,
        "IdleLoadBalancers": [
            {
                "LoadBalancerId": "lb-1l1i6a3k",
                "LoadBalancerName": "lb-613054ce",
                "Region": "ap-guangzhou",
                "Vip": "172.16.32.29",
                "IdleReason": "NO_RULES",
                "Status": 1,
                "Forward": 1
            }
        ],
        "RequestId": "afa28690-f148-483f-9727-58c2f1da3794"
    }
}

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
AuthFailure CAM signature/authentication error
DryRunOperation DryRun operation, which means the DryRun parameter is passed in yet the request will still be successful.
FailedOperation Operation failed.
FailedOperation.InvalidLBStatus Exceptional CLB instance status
InternalError Internal error.
InvalidParameter Parameter error.
InvalidParameter.FormatError Wrong parameter format.
InvalidParameter.InvalidFilter Failed to query the parameter
InvalidParameter.LBIdNotFound Wrong CLB instance ID.
InvalidParameter.ListenerIdNotFound Wrong listener ID.
InvalidParameter.LocationNotFound Unable to find eligible forwarding rules.
InvalidParameter.PortCheckFailed Listener port checks failed due to port conflicts or other reasons.
InvalidParameterValue.Range Wrong parameter value range.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

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

Contact Us
Technical Support

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

Submit a Ticket
7x24 Phone Support