Query Network Load Balancer instances by using ListLoadBalancers - Server Load Balancer - Alibaba Cloud - Server Load Balancer

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

nlb:ListLoadBalancers

get

LoadBalancer

acs:nlb:{#regionId}:{#accountId}:loadbalancer/*

None

Request parameters

Parameter	Type	Required	Description	Example
LoadBalancerType	string	No	The type of load balancing. Only network is returned, which indicates Network Load Balancer (NLB).	network
ZoneId	string	No	The zone name. You can call the DescribeZones operation to query zones.	cn-hangzhou-a
VpcIds	array	No	The VPC ID of the NLB instance. You can query up to 10 VPC IDs at a time.
	string	No	The VPC ID of the NLB instance. You can query up to 10 VPC IDs at a time.	vpc-bp1b49rqrybk45nio****
AddressType	string	No	The IPv4 address type of the NLB instance. Valid values: Internet: The load balancing instance has a public IP address. The DNS domain name is resolved to the public IP address. Therefore, the instance is accessible over the Internet. Intranet: The load balancing instance has only a private IP address. The DNS domain name is resolved to the private IP address. Therefore, the instance is accessible only within the internal network environment of the VPC where the load balancing instance is deployed.	Internet
AddressIpVersion	string	No	The protocol version. Valid values: ipv4: IPv4. DualStack: dual-stack.	ipv4
Ipv6AddressType	string	No	The IPv6 address type of the NLB instance. Valid values: Internet: The load balancing instance has a public IP address. The DNS domain name is resolved to the public IP address. Therefore, the instance is accessible over the Internet. Intranet: The load balancing instance has only a private IP address. The DNS domain name is resolved to the private IP address. Therefore, the instance is accessible only within the internal network environment of the VPC where the load balancing instance is deployed.	Internet
DNSName	string	No	The DNS domain name.	nlb-wb7r6dlwetvt5j****.cn-hangzhou.nlb.aliyuncs.com
LoadBalancerStatus	string	No	The status of the NLB instance. Valid values: Inactive: The instance is stopped. Listeners of the instance no longer forward traffic. Active: The instance is running. Provisioning: The instance is being created. Configuring: Upgrade/Downgrade in progress. Deleting: The instance is being deleted. Deleted: The instance is deleted.	Active
LoadBalancerBusinessStatus	string	No	The business status of the NLB instance. Valid values: Abnormal: The instance is in an abnormal state. Normal: The instance is in a normal state.	Normal
LoadBalancerNames	array	No	The names of the NLB instances. You can query up to 20 instance names at a time.
	string	No	The name of the NLB instance. You can query up to 20 instances at a time.	NLB1
ResourceGroupId	string	No	The resource group ID.	rg-atstuj3rtop****
LoadBalancerIds	array	No	The IDs of the NLB instances. You can query up to 20 instances at a time.
	string	No	The ID of the NLB instance. You can query up to 20 instances at a time.	nlb-83ckzc8d4xlp8o****
Tag	array<object>	No	The labels of the NLB instance.
	object	No	The labels of the NLB instance.
Key	string	No	The tag key of the instance. You can specify up to 20 tag keys. The tag key cannot be an empty string. The tag key can be up to 64 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	KeyTest
Value	string	No	The tag value of the instance. You can specify up to 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	ValueTest
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. Valid values: If this is the first request or no next request exists, you do not need to specify this parameter. If a next request exists, set the value to the NextToken value returned in the previous API call.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	No	The number of entries per page. Valid values: 1 to 100. Default value: 20.	20
RegionId	string	No	The region ID of the NLB instance. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	response
RequestId	string	The request ID.	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
LoadBalancers	array<object>	The list of NLB instances.
	array<object>	The NLB instance information.
RegionId	string	The region ID of the NLB instance.	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 load balancing instance. Only Network is returned, which indicates Network Load Balancer (NLB).	Network
AddressType	string	The IPv4 address type of the NLB instance. Valid values: Internet: The load balancing instance has a public IP address. The DNS domain name is resolved to the public IP address. Therefore, the instance is accessible over the Internet. Intranet: The load balancing instance has only a private IP address. The DNS domain name is resolved to the private IP address. Therefore, the instance is accessible only within the internal network environment of the VPC where the load balancing instance is deployed.	Internet
AddressIpVersion	string	The protocol version. Valid values: ipv4: IPv4. DualStack: dual-stack.	ipv4
Ipv6AddressType	string	The IPv6 address type of the NLB instance. Valid values: Internet: The load balancing instance has a public IP address. The DNS domain name is resolved to the public IP address. Therefore, the instance is accessible over the Internet. Intranet: The load balancing instance has only a private IP address. The DNS domain name is resolved to the private IP address. Therefore, the instance is accessible only within the internal network environment of the VPC where the load balancing instance is deployed.	Internet
LoadBalancerStatus	string	The status of the NLB instance. Valid values: Inactive: The instance is stopped. Listeners of the instance no longer forward traffic. Active: The instance is running. Provisioning: The instance is being created. Configuring: Upgrade/Downgrade in progress. Deleting: The instance is being deleted. Deleted: The instance is deleted.	Active
LoadBalancerBusinessStatus	string	The business status of the NLB instance. Valid values: Abnormal: The instance is in an abnormal state. Normal: The instance is in a normal state.	Normal
OperationLocks	array<object>	The operation lock configuration of the NLB instance. This parameter takes effect when `LoadBalancerBussinessStatus` is Abnormal.
	object	The operation lock configuration of the NLB instance.
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 VPC ID of the NLB instance.	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:22:45Z
ResourceGroupId	string	The resource group ID.	rg-atstuj3rtop****
DNSName	string	The DNS domain name.	nlb-wb7r6dlwetvt5j****.cn-hangzhou.nlb.aliyuncs.com
ZoneMappings	array<object>	The list of zone and vSwitch mappings.
	array<object>	The list of zone and vSwitch mappings.
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.
	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 Internet Shared Bandwidth instance associated with the Internet-facing NLB instance.	cbwp-bp1vevu8h3ieh****
SecurityGroupIds	array	The security groups to which the NLB instance is added.
	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 configuration 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 deletion protection configuration.
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 modification protection configuration.
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>	The list of tags.
	object	The 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 pagination token that is used in the next request to retrieve a new page of results. Valid values: If this is the first request or no next request exists, you do not need to specify this parameter. If a next request exists, set the value to the NextToken value returned in the previous API call.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	The number of entries per page.	20

Examples

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.