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.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: clb.ap-shanghai-fsi.tencentcloudapi.com
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 parameter. The value used for this API: DescribeLoadBalancersDetail. |
Version | Yes | String | Common parameter. The value used for this API: 2018-03-17. |
Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
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 to be returned. The LoadBalancerId and LoadBalancerName are returned by default. |
TargetType | No | String | Target type. Valid values: NODE and GROUP. If the list of fields contains TargetId , TargetAddress , TargetPort , TargetWeight and other fields, Target of the target group or non-target group must be exported. |
Filters.N | No | Array of Filter | Filter condition of querying lists describing CLB instance details: |
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, which is returned for each request. RequestId is required for locating a problem. |
https://clb.tencentcloudapi.com/?Action=DescribeLoadBalancersDetail
&Offset=0
&Limit=20
&<Common request parameters>
{
"Response": {
"TotalCount": 0,
"LoadBalancerDetailSet": [],
"RequestId": "d09b91ba-a81e-4ca3-b423-c64e60127c64"
}
}
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 |
---|---|
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. |
Was this page helpful?