ListLoadBalancers - 查询负载均衡实例信息 - 负载均衡

查询已创建的网络型负载均衡实例的基本信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
nlb:ListLoadBalancers	Read	LoadBalancer acs:nlb:{#regionId}:{#accountId}:loadbalancer/*	无	无

请求参数

名称	类型	必填	描述	示例值
LoadBalancerType	string	否	负载均衡类型。仅取值：network，表示网络型负载均衡。	network
ZoneId	string	否	可用区名称。您可以通过调用 DescribeZones 接口获取。	cn-hangzhou-a
VpcIds	array	否	网络型负载均衡实例的专有网络 ID。一次最多支持查询 10 个 VPC ID。
	string	否	网络型负载均衡实例的专有网络 ID。一次最多支持查询 10 个 VPC ID。	vpc-bp1b49rqrybk45nio****
AddressType	string	否	网络型负载均衡的 IPv4 地址类型。取值： Internet：负载均衡具有公网 IP 地址，DNS 域名被解析到公网 IP，因此可以在公网环境访问。 Intranet：负载均衡只有私网 IP 地址，DNS 域名被解析到私网 IP，因此只能被负载均衡所在 VPC 的内网环境访问。	Internet
AddressIpVersion	string	否	协议版本。取值： ipv4：IPv4 类型。 DualStack：双栈类型。	ipv4
Ipv6AddressType	string	否	网络型负载均衡的 IPv6 地址类型。取值： Internet：公网类型。网络型负载均衡实例具有公网 IP 地址，DNS 域名被解析到公网 IP，因此可以在公网环境访问。 Intranet：私网类型。网络型负载均衡实例只有私网 IP 地址，DNS 域名被解析到私网 IP，因此只能被负载均衡所在 VPC 的内网环境访问。	Internet
DNSName	string	否	DNS 域名。	nlb-wb7r6dlwetvt5j****.cn-hangzhou.nlb.aliyuncs.com
LoadBalancerStatus	string	否	网络型负载均衡实例状态。取值： Inactive：已停止，表示实例监听不会再转发流量。 Active：运行中。 Provisioning：创建中。 Configuring：变配中。 Deleting：删除中。 Deleted：已删除。	Active
LoadBalancerBusinessStatus	string	否	网络型负载均衡的业务状态。取值： Abnormal：异常状态。 Normal：正常状态。	Normal
LoadBalancerNames	array	否	网络型负载均衡实例名称。一次最多支持查询 20 个实例名称。
	string	否	网络型负载均衡实例名称。一次最多支持查询 20 个实例。	NLB1
ResourceGroupId	string	否	资源组 ID。	rg-atstuj3rtop****
LoadBalancerIds	array	否	网络型负载均衡实例的 ID。一次最多支持查询 20 个实例。
	string	否	网络型负载均衡实例的 ID。一次最多支持查询 20 个实例。	nlb-83ckzc8d4xlp8o****
Tag	object []	否	网络型负载均衡实例标签。
Key	string	否	实例的标签键。最多支持输入 20 个标签键。一旦输入该值，则不允许为空字符串。最多支持 64 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	KeyTest
Value	string	否	实例的标签值。最多支持输入 20 个标签值。一旦输入该值，可以为空字符串。最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	ValueTest
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	否	分批次查询时每次显示的条目数。取值范围：1~100，默认值为 20。	20
RegionId	string	否	网络型负载均衡实例所在的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	response
RequestId	string	请求 ID。	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
LoadBalancers	object []	网络型负载均衡实例列表。
RegionId	string	网络型负载均衡实例所在的地域 ID。	cn-hangzhou
LoadBalancerId	string	网络型负载均衡实例 ID。	nlb-83ckzc8d4xlp8o****
LoadBalancerName	string	网络型负载均衡实例名称。	NLB1
LoadBalancerType	string	负载均衡实例类型。仅取值 Network，表示网络型负载均衡。	Network
AddressType	string	网络型负载均衡的 IPv4 地址类型。取值： Internet：负载均衡具有公网 IP 地址，DNS 域名被解析到公网 IP，因此可以在公网环境访问。 Intranet：负载均衡只有私网 IP 地址，DNS 域名被解析到私网 IP，因此只能被负载均衡所在 VPC 的内网环境访问。	Internet
AddressIpVersion	string	协议版本。取值： ipv4：IPv4 类型。 DualStack：双栈类型。	ipv4
Ipv6AddressType	string	网络型负载均衡的 IPv6 地址类型。取值： Internet：负载均衡具有公网 IP 地址，DNS 域名被解析到公网 IP，因此可以在公网环境访问。 Intranet：负载均衡只有私网 IP 地址，DNS 域名被解析到私网 IP，因此只能被负载均衡所在 VPC 的内网环境访问。	Internet
LoadBalancerStatus	string	网络型负载均衡实例状态。取值： Inactive：已停止，表示实例监听不会再转发流量。 Active：运行中。 Provisioning：创建中。 Configuring：变配中。 Deleting：删除中。 Deleted：已删除。	Active
LoadBalancerBusinessStatus	string	网络型负载均衡的业务状态。取值： Abnormal：异常状态。 Normal：正常状态。	Normal
OperationLocks	object []	网络型负载均衡操作锁配置。在`LoadBalancerBussinessStatus`为 Abnormal（异常状态）时有效。
LockType	string	锁定的类型。取值： SecurityLocked：安全锁定。 RelatedResourceLocked：关联锁定。 FinancialLocked：欠费锁定。 ResidualLocked：残留锁定。	SecurityLocked
LockReason	string	锁定的原因。	业务异常
VpcId	string	网络型负载均衡实例的专有网络 ID。	vpc-bp1b49rqrybk45nio****
CreateTime	string	资源创建时间，使用格林威治时间，格式为`yyyy-MM-ddTHH:mm:ssZ`。	2022-07-18T17:22:45Z
ResourceGroupId	string	资源组 ID。	rg-atstuj3rtop****
DNSName	string	DNS 域名。	nlb-wb7r6dlwetvt5j****.cn-hangzhou.nlb.aliyuncs.com
ZoneMappings	object []	可用区及交换机映射列表。
VSwitchId	string	可用区对应的交换机，每个可用区默认使用一台交换机和一个子网。	vsw-bp1rmcrwg3erh1fh8****
ZoneId	string	可用区名称，您可以通过调用 DescribeZones 接口获取。	cn-hangzhou-a
LoadBalancerAddresses	object []	网络型负载均衡实例地址信息。
EniId	string	网络型负载均衡实例挂载的 ENI 的 ID。	eni-bp12f1xhs5yal61a****
PrivateIPv4Address	string	网络型负载均衡实例私网 IPv4 地址。	192.168.3.32
AllocationId	string	弹性公网 IP 实例 ID。	eip-bp1aedxso6u80u0qf****
PublicIPv4Address	string	网络型负载均衡实例公网 IPv4 地址。	120.XX.XX.69
Ipv6Address	string	网络型负载均衡实例 Ipv6 地址。	2001:db8:1:1:1:1:1:1
PrivateIPv4HcStatus	string	网络型负载均衡实例私网 IPv4 地址探测状态。取值： Healthy：健康。 Unhealthy：异常。说明只有可用区状态（Status）为运行中（Active）时才返回该参数。	Healthy
PrivateIPv6HcStatus	string	网络型负载均衡实例 IPv6 地址探测状态。 Healthy：健康。 Unhealthy：异常。说明只有可用区状态（Status）为运行中（Active）时才返回该参数。	Healthy
Status	string	可用区状态。取值： Active：启动。 Stopped：停止。该状态仅支持通过 CADT 容灾管理服务调用实现。 Shifted：DNS 摘除。 Starting：启动中。该状态仅支持通过 CADT 容灾管理服务调用实现。 Stopping：停止中。该状态仅支持通过 CADT 容灾管理服务调用实现。	Active
BandwidthPackageId	string	公网类型实例关联的共享带宽包 ID。	cbwp-bp1vevu8h3ieh****
SecurityGroupIds	array	网络型负载均衡实例加入的安全组。
	string	网络型负载均衡实例加入的安全组。	sg-bp10uag3q0jkxu72****
CrossZoneEnabled	boolean	网络型负载均衡实例是否开启跨可用区。取值： true：开启。 false：关闭。	true
LoadBalancerBillingConfig	object	网络型负载均衡实例计费配置。
PayType	string	网络型负载均衡实例的计费类型。仅取值 PostPay：表示按量计费。	PostPay
DeletionProtectionConfig	object	删除保护配置。
Enabled	boolean	删除保护状态，取值： true：开启状态。 false：关闭状态。	true
Reason	string	更改删除保护状态的原因。长度为 2~128 个英文或中文字符，必须以大小字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。	实例运行中
EnabledTime	string	删除保护开启时间，使用格林威治时间，格式为`yyyy-MM-ddTHH:mm:ssZ`。	2022-12-01T17:22:45Z
ModificationProtectionConfig	object	修改保护配置。
Status	string	网络型负载均衡修改保护状态。取值： NonProtection：不保护，表示不允许传入 Reason。如果配置了 Reason，则清空其配置信息。 ConsoleProtection：控制台修改保护，此时允许传入 Reason。说明当取值为 ConsoleProtection，即开启修改保护后，用户不能通过负载均衡控制台修改实例配置，但可以通过调用 API 修改实例配置。	ConsoleProtection
Reason	string	输入开启修改保护的原因。长度为 2~128 个英文或中文字符，必须以大小字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。仅在 Status 为 ConsoleProtection 时有效。	业务保障期
EnabledTime	string	修改保护开启时间，使用格林威治时间，格式为`yyyy-MM-ddTHH:mm:ssZ`。	2022-12-01T17:22:45Z
Tags	object []	标签列表。
Key	string	实例的标签键。	KeyTest
Value	string	实例的标签值。	ValueTest
TotalCount	integer	列表条目数。	10
NextToken	string	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	分批次查询时每次显示的条目数。	20

示例

正常返回示例

JSON格式

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "LoadBalancers": [
    {
      "RegionId": "cn-hangzhou",
      "LoadBalancerId": "nlb-83ckzc8d4xlp8o****",
      "LoadBalancerName": "NLB1",
      "LoadBalancerType": "Network",
      "AddressType": "Internet",
      "AddressIpVersion": "ipv4",
      "Ipv6AddressType": "Internet",
      "LoadBalancerStatus": "Active",
      "LoadBalancerBusinessStatus": "Normal",
      "OperationLocks": [
        {
          "LockType": "SecurityLocked",
          "LockReason": "业务异常"
        }
      ],
      "VpcId": "vpc-bp1b49rqrybk45nio****",
      "CreateTime": "2022-07-18T17:22:45Z",
      "ResourceGroupId": "rg-atstuj3rtop****",
      "DNSName": "nlb-wb7r6dlwetvt5j****.cn-hangzhou.nlb.aliyuncs.com",
      "ZoneMappings": [
        {
          "VSwitchId": "vsw-bp1rmcrwg3erh1fh8****",
          "ZoneId": "cn-hangzhou-a",
          "LoadBalancerAddresses": [
            {
              "EniId": "eni-bp12f1xhs5yal61a****",
              "PrivateIPv4Address": "192.168.3.32",
              "AllocationId": "eip-bp1aedxso6u80u0qf****",
              "PublicIPv4Address": "120.XX.XX.69",
              "Ipv6Address": "2001:db8:1:1:1:1:1:1",
              "PrivateIPv4HcStatus": "Healthy",
              "PrivateIPv6HcStatus": "Healthy"
            }
          ],
          "Status": "Active"
        }
      ],
      "BandwidthPackageId": "cbwp-bp1vevu8h3ieh****",
      "SecurityGroupIds": [
        "sg-bp10uag3q0jkxu72****"
      ],
      "CrossZoneEnabled": true,
      "LoadBalancerBillingConfig": {
        "PayType": "PostPay"
      },
      "DeletionProtectionConfig": {
        "Enabled": true,
        "Reason": "实例运行中",
        "EnabledTime": "2022-12-01T17:22:45Z"
      },
      "ModificationProtectionConfig": {
        "Status": "ConsoleProtection",
        "Reason": "业务保障期",
        "EnabledTime": "2022-12-01T17:22:45Z"
      },
      "Tags": [
        {
          "Key": "KeyTest",
          "Value": "ValueTest"
        }
      ]
    }
  ],
  "TotalCount": 10,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults": 20
}

错误码

HTTP status code	错误码	错误信息	描述
400	IllegalParam.%s	The param of %s is illegal.	参数%s非法
400	IllegalParam.LoadBalancerType	The LoadBalancerType value is invalid.	参数LoadBalancerType值非法，请检查输入参数。
400	SystemBusy	System is busy, please try again later.	系统繁忙，请稍后重试
400	IllegalParam.loadBalancerName	Param loadBalancerName is illegal.	实例名称非法，请检查参数。
403	Forbidden.NoPermission	Authentication is failed for NoPermission.	因为账号没有权限，所以鉴权失败。

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

变更历史

变更时间

变更内容概要

操作

2024-01-29

OpenAPI 错误码发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	错误码 400 变更
	删除错误码：403

2023-09-26

OpenAPI 错误码发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	错误码 400 变更
	删除错误码：403

2023-09-19

OpenAPI 错误码发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	错误码 400 变更
	错误码 403 变更

2023-09-13

OpenAPI 错误码发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	错误码 400 变更
	删除错误码：403

2023-08-22

OpenAPI 错误码发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	新增错误码：400
	新增错误码：403

2023-06-07

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更。

2023-04-04

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更。