1. 接口描述
接口请求域名： gwlb.tencentcloudapi.com 。
查询一个地域的网关负载均衡实例列表。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeGatewayLoadBalancers。 |
| Version | 是 | String | 公共参数，本接口取值：2024-09-06。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| LoadBalancerIds.N | 否 | Array of String | 网关负载均衡实例ID。支持批量筛选的实例ID数量上限为20个。 示例值：gwlb-pnzsdc1a |
| Limit | 否 | Integer | 一次批量返回网关负载均衡实例的数量，默认为20，最大值为100。 示例值：20 |
| Offset | 否 | Integer | 返回网关负载均衡实例列表的起始偏移量，默认0。 示例值：0 |
| Filters.N | 否 | Array of Filter | 查询负载均衡详细信息列表的过滤条件，每次请求的Filters的上限为10，Filter.Values的上限为100。 Filter.Name和Filter.Values皆为必填项。详细的过滤条件如下： - VpcId - String - 是否必填：否 - （过滤条件）按照网关负载均衡实例所属的私有网络过滤，如“vpc-bhqk****”。 - Vips - String - 是否必填：否 - （过滤条件）按照网关负载均衡实例所属的私有网络过滤，如“10.1.1.1” - tag:tag-key - String - 是否必填：否 - （过滤条件）按照GWLB标签键值对进行过滤，tag-key使用具体的标签键进行替换。 |
| SearchKey | 否 | String | 搜索字段，模糊匹配名称、VIP。 示例值：test-name |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 满足过滤条件的负载均衡实例总数。此数值与入参中的Limit无关。 示例值：1 |
| LoadBalancerSet | Array of GatewayLoadBalancer | 返回的网关负载均衡实例数组。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 指定实例ID查询网关负载均衡
指定实例ID查询网关负载均衡
输入示例
POST / HTTP/1.1
Host: gwlb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeGatewayLoadBalancers
<公共请求参数>
{
"LoadBalancerIds": [
"gwlb-9cpkxxxx"
]
}输出示例
{
"Response": {
"TotalCount": 1,
"LoadBalancerSet": [
{
"LoadBalancerId": "gwlb-9cpkxxxx",
"LoadBalancerName": "the_name_of_gwlb",
"Status": 1,
"SubnetId": "subnet-gbi70xxx",
"TargetGroupId": "",
"VpcId": "vpc-rdiw0xxx",
"Vips": [
"10.0.0.1"
],
"CreateTime": "2024-11-26 16:40:42",
"Tags": [],
"DeleteProtect": false,
"ChargeType": "POSTPAID_BY_HOUR",
"Isolation": 0,
"IsolatedTime": ""
}
],
"RequestId": "7c28eba2-f0d0-427e-9bc2-f44c035825b5"
}
}示例2 指定标签查询网关负载均衡
指定标签查询网关负载均衡
输入示例
POST / HTTP/1.1
Host: gwlb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeGatewayLoadBalancers
<公共请求参数>
{
"Filters": [
{
"Name": "tag:标签键",
"Values": [
"tag-value"
]
}
]
}输出示例
{
"Response": {
"LoadBalancerSet": [
{
"ChargeType": "POSTPAID_BY_HOUR",
"CreateTime": "2025-03-15 18:17:37",
"DeleteProtect": false,
"IsolatedTime": "",
"Isolation": 0,
"LoadBalancerId": "gwlb-jucncd66",
"LoadBalancerName": "gwlb-jucncd66",
"OperateProtect": true,
"Status": 1,
"SubnetId": "subnet-8yvowms4",
"Tags": [
{
"TagKey": "标签键",
"TagValue": "tag-value"
}
],
"TargetGroupId": "",
"Vips": [
"192.168.192.3"
],
"VpcId": "vpc-ga4sg745"
}
],
"RequestId": "cfb0e685-2eb7-40c6-9871-91a5a05e946e",
"TotalCount": 1
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.FormatError | InvalidParameter.FormatError |
| InvalidParameterValue.InvalidFilter | Filter参数输入错误。 |
| InvalidParameterValue.Length | InvalidParameterValue.Length |
