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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ListLoadBalancers

系统规定参数。取值：ListLoadBalancers。
LoadBalancerType String 否 network

负载均衡类型。仅取值：network，表示网络型负载均衡。
ZoneId String 否 cn-hangzhou-a

可用区名称。您可以通过调用DescribeZones接口获取。
VpcIds.N String 否 vpc-bp1b49rqrybk45nio****

网络型负载均衡实例的专有网络ID。一次最多支持查询10个VPC ID。
AddressType String 否 Internet

网络型负载均衡的IPv4地址类型。取值：

  • Internet：负载均衡具有公网IP地址，DNS域名被解析到公网IP，因此可以在公网环境访问。
  • Intranet：负载均衡只有私网IP地址，DNS域名被解析到私网IP，因此只能被负载均衡所在VPC的内网环境访问。
AddressIpVersion String 否 ipv4

协议版本。取值：

  • ipv4：IPv4类型。
  • DualStack：双栈类型。
Ipv6AddressType String 否 Internet

网络型负载均衡的IPv6地址类型。取值：

  • Internet：公网类型。网络型负载均衡实例具有公网IP地址，DNS域名被解析到公网IP，因此可以在公网环境访问。
  • Intranet：私网类型。网络型负载均衡实例只有私网IP地址，DNS域名被解析到私网IP，因此只能被负载均衡所在VPC的内网环境访问。
DNSName String 否 nlb-wb7r6dlwetvt5j****.cn-hangzhou.nlb.aliyuncs.com

DNS域名。
LoadBalancerStatus String 否 Active

网络型负载均衡实例状态。取值：

  • Inactive：已停止，表示实例监听不会再转发流量。
  • Active：运行中。
  • Provisioning：创建中。
  • Configuring：变配中。
  • Deleting：删除中。
  • Deleted：已删除。
LoadBalancerBusinessStatus String 否 Normal

网络型负载均衡的业务状态。取值：

  • Abnormal：异常状态。
  • Normal：正常状态。
LoadBalancerNames.N String 否 NLB1

网络型负载均衡实例名称。一次最多支持查询20个实例。
ResourceGroupId String 否 rg-atstuj3rtop****

资源组ID。
LoadBalancerIds.N String 否 nlb-83ckzc8d4xlp8o****

网络型负载均衡实例的ID。一次最多支持查询20个实例。
Tag.N.Key String 否 KeyTest

实例的标签键。最多支持输入20个标签键。一旦输入该值，则不允许为空字符串。

最多支持64个字符，不能以aliyun和acs:开头，不能包含http://或者https://。
Tag.N.Value String 否 ValueTest

实例的标签值。最多支持输入20个标签值。一旦输入该值，可以为空字符串。

最多支持128个字符，不能以aliyun和acs:开头，不能包含http://或者https://。
NextToken String 否 FFmyTO70tTpLG6I3FmYAXGKPd****

是否拥有下一次查询的令牌（Token）。取值：

  • 第一次查询和没有下一次查询时，均无需填写。
  • 如果有下一次查询，取值为上一次API调用返回的NextToken值。
MaxResults Integer 否 20

分批次查询时每次显示的条目数。取值范围：1~100，默认值为20。
RegionId String 否 cn-hangzhou

网络型负载均衡实例所在的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

返回数据

名称 类型 示例值 描述
RequestId String CEF72CEB-54B6-4AE8-B225-F876FF7BA984

请求ID。
LoadBalancers Array of LoadbalancerInfo

网络型负载均衡实例列表。
RegionId String cn-hangzhou

网络型负载均衡实例所在的地域ID。

LoadBalancerId String nlb-83ckzc8d4xlp8o****

网络型负载均衡实例ID。
LoadBalancerName String NLB1

网络型负载均衡实例名称。
LoadBalancerType String Network

负载均衡实例类型。仅取值Network，表示网络型负载均衡。
AddressType String Internet

网络型负载均衡的IPv4地址类型。取值：

  • Internet：负载均衡具有公网IP地址，DNS域名被解析到公网IP，因此可以在公网环境访问。
  • Intranet：负载均衡只有私网IP地址，DNS域名被解析到私网IP，因此只能被负载均衡所在VPC的内网环境访问。
AddressIpVersion String ipv4

协议版本。取值：

  • ipv4：IPv4类型。
  • DualStack：双栈类型。
Ipv6AddressType String Internet

网络型负载均衡的IPv6地址类型。取值：

  • Internet：负载均衡具有公网IP地址，DNS域名被解析到公网IP，因此可以在公网环境访问。
  • Intranet：负载均衡只有私网IP地址，DNS域名被解析到私网IP，因此只能被负载均衡所在VPC的内网环境访问。
LoadBalancerStatus String Active

网络型负载均衡实例状态。取值：

  • Inactive：已停止，表示实例监听不会再转发流量。
  • Active：运行中。
  • Provisioning：创建中。
  • Configuring：变配中。
  • Deleting：删除中。
  • Deleted：已删除。
LoadBalancerBusinessStatus String Normal

网络型负载均衡的业务状态。取值：

  • Abnormal：异常状态。
  • Normal：正常状态。
OperationLocks Array of OperationLock

网络型负载均衡操作锁配置。在LoadBalancerBussinessStatus为Abnormal（异常状态）时有效。
LockType String SecurityLocked

锁定的类型。取值 ：

  • SecurityLocked：安全锁定。
  • RelatedResourceLocked：关联锁定。
  • FinancialLocked：欠费锁定。
  • ResidualLocked：残留锁定。
LockReason String 业务异常

锁定的原因。
VpcId String vpc-bp1b49rqrybk45nio****

网络型负载均衡实例的专有网络ID。
CreateTime String 2022-07-18T17:22Z

资源创建时间，使用格林威治时间，格式为yyyy-MM-ddTHH:mm:ssZ。
ResourceGroupId String rg-atstuj3rtop****

资源组ID。
DNSName String nlb-wb7r6dlwetvt5j****.cn-hangzhou.nlb.aliyuncs.com

DNS域名。
ZoneMappings Array of ZoneMapping

可用区及交换机映射列表。
VSwitchId String vsw-bp1rmcrwg3erh1fh8****

可用区对应的交换机，每个可用区默认使用一台交换机和一个子网。
ZoneId String cn-hangzhou-a

可用区名称，您可以通过调用DescribeZones接口获取。
LoadBalancerAddresses Array of LoadBalancerAddress

网络型负载均衡实例地址信息。
EniId String eni-bp12f1xhs5yal61a****

网络型负载均衡实例挂载的ENI的ID。
PrivateIPv4Address String 192.168.3.32

网络型负载均衡实例私网IPv4地址。
AllocationId String eip-bp1aedxso6u80u0qf****

弹性公网IP实例ID。
PublicIPv4Address String 120.XX.XX.69

网络型负载均衡实例公网IPv4地址。
Ipv6Address String 2001:db8:1:1:1:1:1:1

网络型负载均衡实例Ipv6地址。
BandwidthPackageId String cbwp-bp1vevu8h3ieh****

公网类型实例关联的共享带宽包ID。
SecurityGroupIds Array of String sg-bp10uag3q0jkxu72****

网络型负载均衡实例加入的安全组。
CrossZoneEnabled Boolean true

网络型负载均衡实例是否开启跨可用区。取值：

  • true：开启。
  • false：关闭。
LoadBalancerBillingConfig Object

网络型负载均衡实例计费配置。
PayType String PostPay

网络型负载均衡实例的计费类型。仅取值PostPay：表示按量计费。
DeletionProtectionConfig Object

删除保护配置。
Enabled Boolean true

删除保护状态，取值：

  • true：开启状态。
  • false：关闭状态。
Reason String 实例运行中

更改删除保护状态的原因。长度为2~128个英文或中文字符，必须以大小字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。
EnabledTime String 2022-12-01T17:22Z

删除保护开启时间，使用格林威治时间，格式为yyyy-MM-ddTHH:mm:ssZ。
ModificationProtectionConfig Object

修改保护配置。
Status String ConsoleProtection

网络型负载均衡修改保护状态。取值：

  • NonProtection：不保护，表示不允许传入Reason。如果配置了Reason，则清空其配置信息。
  • ConsoleProtection：控制台修改保护，此时允许传入Reason。
说明 当取值为ConsoleProtection，即开启修改保护后，用户不能通过负载均衡控制台修改实例配置，但可以通过调用API修改实例配置。
Reason String 业务保障期

输入开启修改保护的原因。长度为2~128个英文或中文字符，必须以大小字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。

仅在Status为ConsoleProtection时有效。
EnabledTime String 2022-12-01T17:22Z

修改保护开启时间，使用格林威治时间，格式为yyyy-MM-ddTHH:mm:ssZ。
Tags Array of tagModels

标签列表。
Key String KeyTest

实例的标签键。
Value String ValueTest

实例的标签值。
TotalCount Integer 10

列表条目数。
NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

是否拥有下一次查询的令牌（Token）。取值：

  • 第一次查询和没有下一次查询时，均无需填写。
  • 如果有下一次查询，取值为上一次API调用返回的NextToken值。
MaxResults Integer 20

分批次查询时每次显示的条目数。

示例

请求示例

http(s)://[Endpoint]/?Action=ListLoadBalancers
&LoadBalancerType=network
&ZoneId=cn-hangzhou-a
&VpcIds=["vpc-bp1b49rqrybk45nio****"]
&AddressType=Internet
&AddressIpVersion=ipv4
&Ipv6AddressType=Internet
&DNSName=nlb-wb7r6dlwetvt5j****.cn-hangzhou.nlb.aliyuncs.com
&LoadBalancerStatus=Active
&LoadBalancerBusinessStatus=Normal
&LoadBalancerNames=["NLB1"]
&ResourceGroupId=rg-atstuj3rtop****
&LoadBalancerIds=["nlb-83ckzc8d4xlp8o****"]
&Tag=[{"Key":"KeyTest","Value":"ValueTest"}]
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&MaxResults=20
&RegionId=cn-hangzhou
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListLoadBalancersResponse>
    <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
    <LoadBalancers>
        <RegionId>cn-hangzhou</RegionId>
        <LoadBalancerId>nlb-83ckzc8d4xlp8o****</LoadBalancerId>
        <LoadBalancerName>NLB1</LoadBalancerName>
        <LoadBalancerType>Network</LoadBalancerType>
        <AddressType>Internet</AddressType>
        <AddressIpVersion>ipv4</AddressIpVersion>
        <Ipv6AddressType>Internet</Ipv6AddressType>
        <LoadBalancerStatus>Active</LoadBalancerStatus>
        <LoadBalancerBusinessStatus>Normal</LoadBalancerBusinessStatus>
        <OperationLocks>
            <LockType>SecurityLocked</LockType>
            <LockReason>业务异常</LockReason>
        </OperationLocks>
        <VpcId>vpc-bp1b49rqrybk45nio****</VpcId>
        <CreateTime>2022-07-18T17:22Z</CreateTime>
        <ResourceGroupId>rg-atstuj3rtop****</ResourceGroupId>
        <DNSName>nlb-wb7r6dlwetvt5j****.cn-hangzhou.nlb.aliyuncs.com</DNSName>
        <ZoneMappings>
            <VSwitchId>vsw-bp1rmcrwg3erh1fh8****</VSwitchId>
            <ZoneId>cn-hangzhou-a</ZoneId>
            <LoadBalancerAddresses>
                <EniId>eni-bp12f1xhs5yal61a****</EniId>
                <PrivateIPv4Address>192.168.3.32</PrivateIPv4Address>
                <AllocationId>eip-bp1aedxso6u80u0qf****</AllocationId>
                <PublicIPv4Address>120.XX.XX.69</PublicIPv4Address>
                <Ipv6Address>2001:db8:1:1:1:1:1:1</Ipv6Address>
            </LoadBalancerAddresses>
        </ZoneMappings>
        <BandwidthPackageId>cbwp-bp1vevu8h3ieh****</BandwidthPackageId>
        <SecurityGroupIds>sg-bp67acfmxazb4p****</SecurityGroupIds>
        <CrossZoneEnabled>true</CrossZoneEnabled>
        <LoadBalancerBillingConfig>
            <PayType>PostPay</PayType>
        </LoadBalancerBillingConfig>
        <Tags>
            <Key>KeyTest</Key>
            <Value>ValueTest</Value>
        </Tags>
    </LoadBalancers>
    <TotalCount>10</TotalCount>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <MaxResults>20</MaxResults>
</ListLoadBalancersResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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:22Z",
    "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"
      } ]
    } ],
    "BandwidthPackageId" : "cbwp-bp1vevu8h3ieh****",
    "SecurityGroupIds" : [ "sg-bp67acfmxazb4p****" ],
    "CrossZoneEnabled" : true,
    "LoadBalancerBillingConfig" : {
      "PayType" : "PostPay"
    },
    "Tags" : [ {
      "Key" : "KeyTest",
      "Value" : "ValueTest"
    } ]
  } ],
  "TotalCount" : 10,
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults" : 20
}

错误码

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