1. 接口描述
接口请求域名： teo.tencentcloudapi.com 。
查询负载均衡实例列表。负载均衡功能内测中，如您需要使用请 联系我们。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeLoadBalancerList。 |
| Version | 是 | String | 公共参数，本接口取值：2022-09-01。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| ZoneId | 是 | String | 站点 ID。 |
| Offset | 否 | Integer | 分页查询偏移量，默认为 0。 |
| Limit | 否 | Integer | 分页查询限制数目，默认值：20，最大值：100。 |
| Filters.N | 否 | Array of Filter | 过滤条件，Filters.Values 的上限为 20。该参数不填写时，返回当前 zone-id 下所有负载均衡实例信息。详细的过滤条件如下： |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 负载均衡实例总数。 |
| LoadBalancerList | Array of LoadBalancer | 负载均衡实例列表。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询负载均衡列表
查询负载均衡列表。
输入示例
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLoadBalancerList
<公共请求参数>
{
"Offset": 0,
"Limit": 10,
"ZoneId": "zone-2ju9lrnpaxol",
"Filters": []
}输出示例
{
"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. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
