1. 接口描述
接口请求域名: dlc.tencentcloudapi.com 。
列出用户在指定地域下的 CLB 负载均衡实例,返回实例 ID、名称与网络类型(OPEN/INTERNAL)。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ListRegionLbs。 |
| Version | 是 | String | 公共参数,本接口取值:2021-01-25。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-singapore 。 |
| ClusterId | 是 | String | TKE 集群 ID,用于查询集群所属 VPC,进而过滤同 VPC 下的独占型 CLB,例如 cls-xxxxxxxx 示例值:cls-xxxxxxxx |
| LoadBalancerIds.N | 否 | Array of String | 负载均衡实例 ID 列表,最多 20 个;不传则查询同地域全部实例 示例值:["lb-b6u34qiq"] |
| Offset | 否 | Integer | 分页偏移量,从 0 开始,默认 0 示例值:0 |
| Limit | 否 | Integer | 分页每页条数,默认 20,最大 100 示例值:10 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 满足条件的负载均衡实例总数(与入参 Limit 无关) 示例值:1 |
| Lbs | Array of LbItem | 负载均衡信息列表 注意:此字段可能返回 null,表示取不到有效值。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 列出同地域 CLB
分页查询同地域负载均衡列表
输入示例
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListRegionLbs
<公共请求参数>
{
"ClusterId": "cls-xxxxxxxx",
"Offset": 0,
"Limit": 20
}
输出示例
{
"Response": {
"TotalCount": 1,
"Lbs": [
{
"LoadBalancerId": "lb-xxxxxxxx",
"LoadBalancerName": "my-lb",
"LoadBalancerType": "OPEN"
}
],
"RequestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.ExternalService | 外部服务异常 |