查询负载均衡实例列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| gwlb:ListLoadBalancers | list |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ZoneIds | array | 否 | 可用区 ID，通过调用网关型负载均衡 DescribeZones 接口获得。一次最多支持查询 20 个 可用区 ID。 | |
| string | 否 | 可用区 ID。 | cn-beijing-h | |
| VpcIds | array | 否 | 专有网络 ID。一次最多支持查询 20 个 VPC ID。 | |
| VpcId | string | 否 | 专用网络 ID。 | vpc-bp1xuejaht4o7yhh2**** |
| AddressIpVersion | string | 否 | 协议版本。取值：
枚举值：
| Ipv4 |
| LoadBalancerStatus | string | 否 | 网关型负载均衡的实例状态。取值：
| Active |
| LoadBalancerBusinessStatus | string | 否 | 网关型负载均衡的业务状态。取值：
| Normal |
| LoadBalancerNames | array | 否 | 网关型负载均衡实例名称。一次最多支持查询 20 个实例名称。 | |
| LoadBalancerName | string | 否 | 网络型负载均衡实例名称。 | testGwlbName |
| ResourceGroupId | string | 否 | 资源组 ID。 | rg-aek2htf5qsyrn**** |
| LoadBalancerIds | array | 否 | 网关型负载均衡实例的 ID。一次最多支持查询 20 个实例。 | |
| LoadBalancerId | string | 否 | 网关型负载均衡实例的 ID。 | gwlb-cp6prgqy40hols**** |
| Tag | array<object> | 否 | 标签列表。一次调用最多支持 20 个标签。 | |
| TagModel | object | 否 | ||
| Key | string | 否 | 标签键。一旦传入该值，则不允许为空字符串。 一个标签健最多支持 128 个字符，不能以 | testTagKey |
| Value | string | 否 | 标签值。最多支持 256 个字符，不能包含 | testTagValue |
| NextToken | string | 否 | 是否拥有下一次查询的令牌（Token）。取值：
| WyJyb290IiwibiIsIm4iLDEsMCwxNjg1MDY1NTgyNzYwLCI2NDcwMGY2ZTc2Zjc0MWFiZGEyZjQyNzc4ZDk2MmJkOTk3ZGZmM2Nm**** |
| MaxResults | integer | 否 | 分批次查询时每次显示的条目数。取值范围：1~1000，默认值：20。 | 20 |
| Skip | integer | 否 | 查询时跳过指定的条目数。 | 1 |
返回参数
示例
正常返回示例
JSON格式
{
"LoadBalancers": [
{
"AddressIpVersion": "IPv4",
"CreateTime": "2024-08-05T18:24:07Z",
"LoadBalancerBusinessStatus": "Normal",
"LoadBalancerId": "gwlb-9njtjmqt7zfcqm****\n",
"LoadBalancerName": "testGwlbName",
"LoadBalancerStatus": "Active",
"ResourceGroupId": "rg-aek26jasguy****",
"Tags": [
{
"Key": "testTagKey",
"Value": "testTagValue"
}
],
"VpcId": "vpc-uf6eg0vndlsa84n7r****",
"ZoneMappings": [
{
"LoadBalancerAddresses": [
{
"EniId": "eni-bp17qv9zbzyqy629****",
"PrivateIpv4Address": "192.168.XX.XX"
}
],
"VSwitchId": "vsw-2zemule5dz7okwqfv****",
"ZoneId": "cn-hangzhou-g"
}
]
}
],
"MaxResults": 20,
"NextToken": "CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAIldD2UAAAAACjMDLgAAADFTNzMyZDMwMzAzMDY5NzQzNDM0NmI3NzM2NjUzNzc4NzM2YTc0NjYzOTYz****",
"RequestId": "378A80E9-4262-5D8E-8D62-0969E52D7358",
"TotalCount": 100
}错误码
访问错误中心查看更多错误码。