ListLoadBalancers - Server Load Balancer - Alibaba Cloud Documentation Center

Queries the basic information about Network Load Balancer (NLB) instances.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
nlb:ListLoadBalancers	get	LoadBalancer `acs:nlb:{#regionId}:{#accountId}:loadbalancer/*`	none	none

Request parameters

Parameter	Type	Required	Description	Example
LoadBalancerType	string	No	The type of the Server Load Balancer (SLB) instances. Set the value to network, which specifies NLB.	network
ZoneId	string	No	The ID of the zone. You can call the DescribeZones operation to query the most recent zone list.	cn-hangzhou-a
VpcIds	array	No	The IDs of the virtual private clouds (VPCs) where the NLB instances are deployed. You can specify up to 10 VPC IDs in each call.
VpcId	string	No	The ID of a VPC where the NLB instance is deployed. You can specify up to 10 VPC IDs in each call.	vpc-bp1b49rqrybk45nio****
AddressType	string	No	The type of IPv4 address used by the NLB instance. Valid values: Internet: The NLB instance uses a public IP address. The domain name of the NLB instance is resolved to the public IP address. The NLB instance can be accessed over the Internet. Intranet: The NLB instance uses a private IP address. The domain name of the NLB instance is resolved to the private IP address. The NLB instance can be accessed over the VPC where the NLB instance is deployed.	Internet
AddressIpVersion	string	No	The IP version of the NLB instance. Valid values: ipv4: IPv4 DualStack: dual-stack	ipv4
Ipv6AddressType	string	No	The type of IPv6 address used by the NLB instance. Valid values: Internet: The NLB instance uses a public IP address. The domain name of the NLB instance is resolved to the public IP address. The NLB instance can be accessed over the Internet. Intranet: The NLB instance uses a private IP address. The domain name of the NLB instance is resolved to the private IP address. The NLB instance can be accessed over the VPC where the NLB instance is deployed.	Internet
DNSName	string	No	The domain name of the NLB instance.	nlb-wb7r6dlwetvt5j****.cn-hangzhou.nlb.aliyuncs.com
LoadBalancerStatus	string	No	The status of the NLB instance. Valid values: Inactive: The NLB instance is disabled. Listeners of an NLB instance in the Inactive state do not forward traffic. Active: The NLB instance is running. Provisioning: The NLB instance is being created. Configuring: The NLB instance is being modified. Deleting: The NLB instance is being deleted. Deleted: The NLB instance is deleted.	Active
LoadBalancerBusinessStatus	string	No	The business status of the NLB instance. Valid values: Abnormal: The NLB instance is not working as expected. Normal: The NLB instance is working as expected.	Normal
LoadBalancerNames	array	No	The names of the NLB instances. You can specify up to 20 names in each call.
LoadBalancerName	string	No	The name of the NLB instance. You can specify up to 20 names in each call.	NLB1
ResourceGroupId	string	No	The ID of the resource group to which the instance belongs.	rg-atstuj3rtop****
LoadBalancerIds	array	No	The NLB instance IDs. You can specify up to 20 IDs in each call.
LoadBalancerId	string	No	The NLB instance ID. You can specify up to 20 IDs in each call.	nlb-83ckzc8d4xlp8o****
Tag	array<object>	No	The tags of the NLB instance.
	object	No	The tag of the NLB instance.
Key	string	No	The key of the tag. You can specify up to 20 tags. The tag key cannot be an empty string. It must be 1 to 64 characters in length, cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	KeyTest
Value	string	No	The value of the tag. You can specify up to 20 tags. The tag value can be an empty string. The tag value can be up to 128 characters in length, cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	ValueTest
NextToken	string	No	The pagination token used to specify a particular page of results. Valid values: Leave this parameter empty for the first query or the only query. Set this parameter to the value of NextToken obtained from the previous query.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	No	The number of entries to return in each call. Valid values: 1 to 100. Default value: 20.	20
RegionId	string	No	The ID of the region where the NLB instance is deployed. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object	response
RequestId	string	The ID of the request.	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
LoadBalancers	array<object>	The NLB instances.
LoadbalancerInfo	object	The NLB instances.
RegionId	string	The ID of the region where the NLB instance is deployed.	cn-hangzhou
LoadBalancerId	string	The ID of the NLB instance.	nlb-83ckzc8d4xlp8o****
LoadBalancerName	string	The name of the NLB instance.	NLB1
LoadBalancerType	string	The type of the SLB instance. Only Network is returned, which indicates NLB.	Network
AddressType	string	The type of IPv4 address used by the NLB instance. Valid values: Internet: The NLB instance uses a public IP address. The domain name of the NLB instance is resolved to the public IP address. Therefore, the NLB instance can be accessed over the Internet. Intranet: The NLB instance uses a private IP address. The domain name of the NLB instance is resolved to the private IP address. Therefore, the NLB instance can be accessed over the VPC where the NLB instance is deployed.	Internet
AddressIpVersion	string	The IP version. Valid values: ipv4: IPv4 DualStack: dual stack	ipv4
Ipv6AddressType	string	The type of IPv6 address used by the NLB instance. Valid values: Internet: The NLB instance uses a public IP address. The domain name of the NLB instance is resolved to the public IP address. Therefore, the NLB instance can be accessed over the Internet. Intranet: The NLB instance uses a private IP address. The domain name of the NLB instance is resolved to the private IP address. Therefore, the NLB instance can be accessed over the VPC where the NLB instance is deployed.	Internet
LoadBalancerStatus	string	The status of the NLB instance. Valid values: Inactive: The NLB instance is disabled. Listeners of NLB instances in the Inactive state do not forward traffic. Active: The NLB instance is running. Provisioning: The NLB instance is being created. Configuring: The NLB instance is being modified. Deleting: The NLB instance is being deleted. Deleted: The NLB instance is deleted.	Active
LoadBalancerBusinessStatus	string	The business status of the NLB instance. Valid values: Abnormal: The NLB instance is not working as expected. Normal: The NLB instance is working as expected.	Normal
OperationLocks	array<object>	The configuration of the operation lock. This parameter takes effect if the value of `LoadBalancerBussinessStatus` is Abnormal.
OperationLock	object	The configuration of the operation lock.
LockType	string	The type of lock. Valid values: SecurityLocked: The NLB instance is locked due to security reasons. RelatedResourceLocked: The NLB instance is locked due to association issues. FinancialLocked: The NLB instance is locked due to overdue payments. ResidualLocked: The NLB instance is locked because the payments of the associated resources are overdue and the resources are released.	SecurityLocked
LockReason	string	The reason why the NLB instance is locked.	Service exception
VpcId	string	The ID of the VPC where the NLB instance is deployed.	vpc-bp1b49rqrybk45nio****
CreateTime	string	The time when the resource was created. The time is displayed in UTC in the `yyyy-MM-ddTHH:mm:ssZ` format.	2022-07-18T17:22Z
ResourceGroupId	string	The ID of the resource group.	rg-atstuj3rtop****
DNSName	string	The domain name of the NLB instance.	nlb-wb7r6dlwetvt5j****.cn-hangzhou.nlb.aliyuncs.com
ZoneMappings	array<object>	The mappings between zones and vSwitches.
ZoneMapping	object	The information about the array object.
VSwitchId	string	The ID of the vSwitch in the zone. By default, each zone contains one vSwitch and one subnet.	vsw-bp1rmcrwg3erh1fh8****
ZoneId	string	The name of the zone. You can call the DescribeZones operation to query the zones.	cn-hangzhou-a
LoadBalancerAddresses	array<object>	The IP addresses that are used by the NLB instance.
LoadBalancerAddress	object	The information about the array object.
EniId	string	The ID of the elastic network interface (ENI) attached to the NLB instance.	eni-bp12f1xhs5yal61a****
PrivateIPv4Address	string	The private IPv4 address of the NLB instance.	192.168.3.32
AllocationId	string	The ID of the elastic IP address (EIP).	eip-bp1aedxso6u80u0qf****
PublicIPv4Address	string	The public IPv4 address of the NLB instance.	120.XX.XX.69
Ipv6Address	string	The IPv6 address used by the NLB instance.	2001:db8:1:1:1:1:1:1
PrivateIPv4HcStatus	string	The health status of the private IPv4 address of the NLB instance. Valid values: Healthy Unhealthy Note This parameter is returned only when the Status of the zone is Active.	Healthy
PrivateIPv6HcStatus	string	The health status of the IPv6 address of the NLB instance. Valid values: Healthy Unhealthy Note This parameter is returned only when the Status of the zone is Active.	Healthy
Status	string	The zone status. Valid values: Active: The zone is available. Stopped: The zone is disabled. You can set the zone to this status only by using Cloud Architect Design Tools (CADT). Shifted: The DNS record is removed. Starting: The zone is being enabled. You can set the zone to this status only by using CADT. Stopping You can set the zone to this status only by using CADT.	Active
BandwidthPackageId	string	The ID of the EIP bandwidth plan that is associated with the NLB instance if the NLB instance uses a public IP address.	cbwp-bp1vevu8h3ieh****
SecurityGroupIds	array	The security group to which the NLB instance is added.
SecurityGroupId	string	The security group to which the NLB instance is added.	sg-bp10uag3q0jkxu72****
CrossZoneEnabled	boolean	Indicates whether cross-zone load balancing is enabled for the NLB instance. Valid values: true: enabled false: disabled	true
LoadBalancerBillingConfig	object	The billing settings of the NLB instance.
PayType	string	The billing method of the NLB instance. Only PostPay is supported, which indicates the pay-as-you-go billing method.	PostPay
DeletionProtectionConfig	object	The configuration of the deletion protection feature.
Enabled	boolean	Indicates whether deletion protection is enabled. Valid values: true: enabled false: disabled	true
Reason	string	The reason why the deletion protection feature is enabled or disabled. The reason must be 2 to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The reason must start with a letter.	The instance is running
EnabledTime	string	The time when deletion protection was enabled. The time is displayed in UTC in `yyyy-MM-ddTHH:mm:ssZ` format.	2022-12-01T17:22Z
ModificationProtectionConfig	object	The configuration of the configuration read-only mode.
Status	string	Indicates whether the configuration read-only mode is enabled. Valid values: NonProtection: disabled. In this case, Reason is not returned. If Reason is set, the value is cleared. ConsoleProtection: enabled. In this case, Reason is returned. Note If you set this parameter to ConsoleProtection, you cannot use the NLB console to modify instance configurations. However, you can call API operations to modify instance configurations.	ConsoleProtection
Reason	string	The reason why the configuration read-only mode is enabled. The reason must be 2 to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The reason must start with a letter. This parameter takes effect only if Status is set to ConsoleProtection.	Service guarantee period
EnabledTime	string	The time when the configuration read-only mode was enabled. The time is displayed in UTC in `yyyy-MM-ddTHH:mm:ssZ` format.	2022-12-01T17:22Z
Tags	array<object>	A list of tags.
tagModels	object	A list of tags.
Key	string	The tag key.	KeyTest
Value	string	The tag value.	ValueTest
TotalCount	integer	The total number of entries returned.	10
NextToken	string	The token that determines the start point of the next query. Valid values: If this is your first query and no subsequent queries are to be sent, ignore this parameter. If a subsequent query is to be sent, set the parameter to the value of NextToken that is returned from the last call.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	The number of entries returned per page.	20

Examples

Sample success responses

JSONformat

{
  "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": "Service exception\n"
        }
      ],
      "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",
              "PrivateIPv4HcStatus": "Healthy",
              "PrivateIPv6HcStatus": "Healthy"
            }
          ],
          "Status": "Active"
        }
      ],
      "BandwidthPackageId": "cbwp-bp1vevu8h3ieh****",
      "SecurityGroupIds": [
        "sg-bp10uag3q0jkxu72****"
      ],
      "CrossZoneEnabled": true,
      "LoadBalancerBillingConfig": {
        "PayType": "PostPay"
      },
      "DeletionProtectionConfig": {
        "Enabled": true,
        "Reason": "The instance is running\n",
        "EnabledTime": "2022-12-01T17:22Z"
      },
      "ModificationProtectionConfig": {
        "Status": "ConsoleProtection",
        "Reason": "Service guarantee period\n",
        "EnabledTime": "2022-12-01T17:22Z"
      },
      "Tags": [
        {
          "Key": "KeyTest",
          "Value": "ValueTest"
        }
      ]
    }
  ],
  "TotalCount": 10,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults": 20
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam.%s	The param of %s is illegal.	-
400	IllegalParam.LoadBalancerType	The LoadBalancerType value is invalid.	-
400	SystemBusy	System is busy, please try again later.	-
400	IllegalParam.loadBalancerName	Param loadBalancerName is illegal.	The instance name is invalid. Check the parameters.
403	Forbidden.NoPermission	Authentication is failed for NoPermission.	Authentication is failed for NoPermission.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-01-29	The Error code has changed	View Change Details
2023-09-26	The Error code has changed	View Change Details
2023-09-19	The Error code has changed	View Change Details
2023-09-13	The Error code has changed	View Change Details
2023-08-22	The Error code has changed	View Change Details
2023-06-07	The response structure of the API has changed	View Change Details
2023-04-04	The response structure of the API has changed	View Change Details