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.
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 |
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. |
https://clb.tencentcloudapi.com/?Action=DescribeIdleLoadBalancers
&<Common request parameters>
{
"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"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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?