DescribeLoadBalancerList
1. API Description
Domain name for API request: teo.intl.tencentcloudapi.com.
This API is used to query the LoadBalancer list. The load balancing feature is in beta test. If you need to use it, contact us.
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: DescribeLoadBalancerList. |
| Version | Yes | String | Common Params. The value used for this API: 2022-09-01. |
| Region | No | String | Common Params. This parameter is not required. |
| ZoneId | Yes | String | Zone ID. |
| Offset | No | Integer | Offset of paginated query. Default value: 0. |
| Limit | No | Integer | Paginated query limit. Default value: 20, maximum value: 100. |
| Filters.N | No | Array of Filter | Filter criteria. The maximum value of Filters.Values is 20. If this parameter is left empty, all LoadBalancer information under the current zone ID will be returned. The detailed filter criteria are as follows: |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of LoadBalancers. |
| LoadBalancerList | Array of LoadBalancer | LoadBalancer list. |
| 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 the LoadBalancer List
This example shows you how to query the LoadBalancer list.
Input Example
POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLoadBalancerList
<Common request parameters>
{
"Offset": 0,
"Limit": 10,
"ZoneId": "zone-2ju9lrnpaxol",
"Filters": []
}
Output Example
{
"Response": {
"RequestId": "b8ecbb28-9360-4895-8138-668315e80b05",
"LoadBalancerList": [
{
"FailoverPolicy": "OtherOriginGroup",
"HealthChecker": {
"CriticalThreshold": 0,
"ExpectedCodes": [],
"FollowRedirect": "",
"Headers": [],
"HealthThreshold": 0,
"Interval": 0,
"Method": "",
"Path": "",
"Port": 0,
"RecvContext": "",
"SendContext": "",
"Timeout": 0,
"Type": "NoCheck"
},
"InstanceId": "lb-2my56s2a4fw7",
"L4UsedList": [],
"L7UsedList": [],
"Name": "dyn-lb",
"OriginGroupHealthStatus": [
{
"OriginGroupID": "og-30l5kv5z2bse",
"OriginGroupName": "allen_test_slave",
"OriginHealthStatus": [
{
"Healthy": "Unhealthy",
"Origin": "1.12.231.49"
},
{
"Healthy": "Unhealthy",
"Origin": "43.137.35.174"
}
],
"OriginType": "GENERAL",
"Priority": "priority_1"
},
{
"OriginGroupID": "og-30l5kv5z2ase",
"OriginGroupName": "allen_test_master",
"OriginHealthStatus": [
{
"Healthy": "Unhealthy",
"Origin": "1.116.214.39"
},
{
"Healthy": "Unhealthy",
"Origin": "43.138.115.171"
}
],
"OriginType": "GENERAL",
"Priority": "priority_2"
},
{
"OriginGroupID": "og-30l5kv5z2bsf",
"OriginGroupName": "test-origin",
"OriginHealthStatus": [
{
"Healthy": "Unhealthy",
"Origin": "1.1.1.1"
},
{
"Healthy": "Unhealthy",
"Origin": "www.baidu.com"
}
],
"OriginType": "GENERAL",
"Priority": "priority_3"
},
{
"OriginGroupID": "og-31l5kv5z2bsf",
"OriginGroupName": "origin-general",
"OriginHealthStatus": [
{
"Healthy": "Unhealthy",
"Origin": "1.1.1.1"
},
{
"Healthy": "Unhealthy",
"Origin": "2.2.2.2"
}
],
"OriginType": "GENERAL",
"Priority": "priority_4"
}
],
"Status": "Running",
"SteeringPolicy": "Pritory",
"Type": "GENERAL"
},
{
"FailoverPolicy": "OtherOriginGroup",
"HealthChecker": {
"CriticalThreshold": 2,
"ExpectedCodes": [],
"FollowRedirect": "",
"Headers": [],
"HealthThreshold": 3,
"Interval": 30,
"Method": "",
"Path": "",
"Port": 3344,
"RecvContext": "",
"SendContext": "",
"Timeout": 5,
"Type": "TCP"
},
"InstanceId": "lb-2my4ja5zzo1j",
"L4UsedList": [],
"L7UsedList": [],
"Name": "pic-lb",
"OriginGroupHealthStatus": [
{
"OriginGroupID": "og-30l5kv5z2bse",
"OriginGroupName": "allen_test_master",
"OriginHealthStatus": [
{
"Healthy": "Unhealthy",
"Origin": "1.116.214.39"
},
{
"Healthy": "Unhealthy",
"Origin": "43.138.115.171"
}
],
"OriginType": "GENERAL",
"Priority": "priority_1"
},
{
"OriginGroupID": "og-30l5kv5z2bse",
"OriginGroupName": "allen_test_slave",
"OriginHealthStatus": [
{
"Healthy": "Unhealthy",
"Origin": "1.12.231.49"
},
{
"Healthy": "Unhealthy",
"Origin": "43.137.35.174"
}
],
"OriginType": "GENERAL",
"Priority": "priority_2"
}
],
"Status": "Running",
"SteeringPolicy": "Pritory",
"Type": "GENERAL"
}
],
"TotalCount": 2
}
}
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. |