ListLoadBalancers - 查询负载均衡实例列表 - 负载均衡

查询负载均衡实例列表。

调试

您可以在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：Ipv4 类型。枚举值： IPv4：IPv4。 DualStack：DualStack。	Ipv4
LoadBalancerStatus	string	否	网关型负载均衡的实例状态。取值： Active：运行中。 Inactive：已停止，表示实例监听不会再转发流量。 Provisioning：创建中。 Configuring：变配中。	Active
LoadBalancerBusinessStatus	string	否	网关型负载均衡的业务状态。取值： Normal：正常状态。 FinancialLocked：欠费锁定状态。	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 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	testTagKey
Value	string	否	标签值。最多支持 256 个字符，不能包含`http://`或`https://`。	testTagValue
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：如果 NextToken 为空表示没有下一次查询。如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。	WyJyb290IiwibiIsIm4iLDEsMCwxNjg1MDY1NTgyNzYwLCI2NDcwMGY2ZTc2Zjc0MWFiZGEyZjQyNzc4ZDk2MmJkOTk3ZGZmM2Nm****
MaxResults	integer	否	分批次查询时每次显示的条目数。取值范围：1~1000，默认值：20。	20
Skip	integer	否	查询时跳过指定的条目数。	1

返回参数

名称	类型	描述	示例值
	object
LoadBalancers	array<object>	网关型负载均衡实例列表。
Data	object
AddressIpVersion	string	协议版本。取值： IPv4：IPv4 类型。	IPv4
CreateTime	string	资源创建时间，使用格林威治时间，格式为yyyy-MM-ddTHH:mm:ssZ。	2024-08-05T18:24:07Z
LoadBalancerBusinessStatus	string	网关型负载均衡的业务状态。取值： Normal：正常状态。 FinancialLocked：欠费锁定状态。	Normal
LoadBalancerId	string	网关型负载均衡实例的 ID。	gwlb-9njtjmqt7zfcqm****
LoadBalancerName	string	网关型负载均衡实例名称。长度为 2~128 个英文或中文字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。	testGwlbName
LoadBalancerStatus	string	网关型负载均衡的实例状态。取值： Active：运行中。 Inactive：已停止，表示实例监听不会再转发流量。 Provisioning：创建中。 Configuring：变配中。	Active
ResourceGroupId	string	资源组 ID。	rg-aek26jasguy****
Tags	array<object>	标签列表。
TagModel	object
Key	string	标签键。一旦传入该值，则不允许为空字符串。一个标签健最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	testTagKey
Value	string	标签值。最多支持输入 20 个标签值。一旦传入该值，可以为空字符串。一个标签值最多支持 128 个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	testTagValue
VpcId	string	专用网络 ID。	vpc-uf6eg0vndlsa84n7r****
ZoneMappings	array<object>	可用区及交换机映射列表。至少需要添加一个可用区，最多支持添加 20 个可用区。若当前地域支持 2 个及以上的可用区，建议添加 2 个及以上可用区。
ZoneEniModel	object
LoadBalancerAddresses	array<object>	网关型负载均衡实例地址信息。
EniModels	object
EniId	string	弹性网卡 ENI ID。	eni-bp17qv9zbzyqy629****
PrivateIpv4Address	string	IPv4 私网地址。	192.168.XX.XX
VSwitchId	string	可用区对应的交换机，每个可用区默认使用一台交换机和一个子网。	vsw-2zemule5dz7okwqfv****
ZoneId	string	可用区 ID，通过调用网关型负载均衡 DescribeZones 接口获得。	cn-hangzhou-g
MaxResults	integer	分批次查询时每次显示的条目数。取值范围：1~1000，默认值：20。	20
NextToken	string	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。	CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAIldD2UAAAAACjMDLgAAADFTNzMyZDMwMzAzMDY5NzQzNDM0NmI3NzM2NjUzNzc4NzM2YTc0NjYzOTYz****
RequestId	string	请求 ID。	378A80E9-4262-5D8E-8D62-0969E52D7358
TotalCount	integer	列表条目总数。	100

示例

正常返回示例

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
}

错误码

访问错误中心查看更多错误码。