Cloud Load Balancer
- Release Notes and Announcements
- Product Introduction
- Product Comparison
- Purchase Guide
- CLB Resource Package
- Getting Started
- Operation Guide
- CLB Instance
- CLB Listener
- Real Server
- Health Check
- Certificate Management
- Log Management
- Monitoring and Alarm
- Cloud Access Management
- Practical Tutorial
- Obtaining Real Client IPs
- Ops Guide
- Troubleshooting
- API Documentation
- Instance APIs
- Listener APIs
- Backend Service APIs
- Target Group APIs
- Redirection APIs
- Other APIs
- Classic CLB APIs
- Making API Requests
- Load Balancing APIs
- CLB API 2017
- Making API Requests
- Request Structure
- Returned Results
- General APIs
- Classic CLB APIs
- APIs for CLB Instances
- APIs for Listeners
- CLB Real Server APIs
- APIs for Health Check
- FAQs
- Troubleshooting Health Check Issues
DescribeLoadBalancersDetail
Last updated: 2024-09-05 19:29:56
1. API Description
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.
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: 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: |
3. Output Parameters
| 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. |
4. Example
Example1 Querying CLB Instance Details
Input Example
POST / HTTP/1.1
Host: clb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLoadBalancersDetail
<Common request parameters>
{
"Limit": "2",
"Offset": "5"
}
Output Example
{
"Response": {
"TotalCount": 0,
"LoadBalancerDetailSet": [],
"RequestId": "d09b91ba-a81e-4ca3-b423-c64e60127c64"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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. |
| 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?
You can also Contact Sales or Submit a Ticket for help.
Yes
No