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.
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: |
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. |
POST / HTTP/1.1
Host: clb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLoadBalancersDetail
<Common request parameters>
{
"Limit": "2",
"Offset": "5"
}
{
"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?