ListLoadBalancers - Server Load Balancer - Alibaba Cloud Documentation Center

Queries Gateway Load Balancer (GWLB) 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:
- The required resource types are displayed in bold characters.
- 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
gwlb:ListLoadBalancers	list	LoadBalancer `acs:gwlb:{#regionId}:{#accountId}:loadbalancer/` LoadBalancer `acs:gwlb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}` VPC `acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
ZoneIds	array	No	The zone IDs. You can query at most 20 zone IDs in each call.
	string	No	The zone ID of the cluster.	cn-beijing-h
VpcIds	array	No	The virtual private cloud (VPC) IDs. You can query at most 20 IDs in each call.
VpcId	string	No	The VPC ID.	vpc-bp1xuejaht4o7yhh2****
AddressIpVersion	string	No	The IP version. Valid values: Ipv4: IPv4 Enumeration values: IPv4: IPv4 DualStack: DualStack	IPv4
LoadBalancerStatus	string	No	The GWLB instance status. Valid values: Active: The GWLB instance is running. Inactive: The GWLB instance is disabled. Listeners of GWLB instances in the Inactive state do not forward traffic. Provisioning: The GWLB instance is being created. Configuring: The GWLB instance is being modified.	Active
LoadBalancerBusinessStatus	string	No	The business status of the GWLB instance. Valid values: Normal: running as expected FinancialLocked: locked due to overdue payments	Normal
LoadBalancerNames	array	No	The GWLB instance names. You can specify at most 20 GWLB instance names in each call.
LoadBalancerName	string	No	The GWLB instance name.	testGwlbName
ResourceGroupId	string	No	The resource group ID.	rg-aek2htf5qsyrn****
LoadBalancerIds	array	No	The GWLB instance IDs. You can query at most 20 GWLB instances in each call.
LoadBalancerId	string	No	The GWLB instance ID.	gwlb-cp6prgqy40hols****
Tag	array<object>	No	The tags. You can specify at most 20 tags in each call.
TagModel	object	No	The information about the tag.
Key	string	No	The tag key The tag key cannot be an empty string. The tag key can be up to 128 characters in length. The tag key cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	testTagKey
Value	string	No	The tag value The tag value can be up to 256 characters in length and cannot contain `http://` or `https://`.	testTagValue
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. Valid values: If NextToken is empty, no next page exists. If a value of NextToken is returned, the value indicates the token that is used for the next query.	WyJyb290IiwibiIsIm4iLDEsMCwxNjg1MDY1NTgyNzYwLCI2NDcwMGY2ZTc2Zjc0MWFiZGEyZjQyNzc4ZDk2MmJkOTk3ZGZmM2Nm****
MaxResults	integer	No	The number of entries per page. Valid values: 1 to 1000. Default value: 20.	20
Skip	integer	No	The number of entries to be skipped in the call.	1

Response parameters

Parameter	Type	Description	Example
	object
LoadBalancers	array<object>	The GWLB instances.
Data	object	The information about the GWLB instances.
AddressIpVersion	string	The IP version. Valid values: IPv4	IPv4
CreateTime	string	The time when the resource was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2024-08-05 18:24:07
LoadBalancerBusinessStatus	string	The business status of the GWLB instance. Valid values: Normal: running as expected FinancialLocked: locked due to overdue payments	Normal
LoadBalancerId	string	The GWLB instance ID.	gwlb-9njtjmqt7zfcqm****
LoadBalancerName	string	The GWLB instance name. The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.	testGwlbName
LoadBalancerStatus	string	The GWLB instance status. Valid values: Active: The GWLB instance is running. Inactive: The GWLB instance is disabled. Listeners of GWLB instances in the Inactive state do not forward traffic. Provisioning: The GWLB instance is being created. Configuring: The GWLB instance is being modified.	Active
ResourceGroupId	string	The resource group ID.	rg-aek26jasguy****
Tags	array<object>	The tags.
TagModel	object	The information about the tag.
Key	string	The tag key. The tag key cannot be an empty string. The tag key can be up to 128 characters in length. The tag key cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	testTagKey
Value	string	The tag value. You can specify at most 20 tag values. The tag value cannot be an empty string. The tag value can be up to 128 characters in length. It must start with a letter and can contain digits, periods (.), underscores (_), and hyphens (-). It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	testTagValue
VpcId	string	The VPC ID.	vpc-uf6eg0vndlsa84n7r****
ZoneMappings	array<object>	The mappings between zones and vSwitches. You must specify at least one zone. You can specify at most 20 zones. If the region supports two or more zones, specify at least two zones.
ZoneEniModel	object	The information about the zones and vSwitches.
LoadBalancerAddresses	array<object>	The GWLB instance addresses.
EniModels	object	The information about the GWLB instance addresses.
EniId	string	The ID of the elastic network interface (ENI) used by the GWLB instance.	eni-bp17qv9zbzyqy629****
PrivateIpv4Address	string	The private IPv4 address.	192.168.XX.XX
VSwitchId	string	The ID of the vSwitch in the zone. By default, each zone contains one vSwitch and one subnet.	vsw-2zemule5dz7okwqfv****
ZoneId	string	The zone ID. You can call the DescribeZones operation to query the most recent zone list.	cn-hangzhou-g
MaxResults	integer	The number of entries per page. Valid values: 1 to 1000. Default value: 20.	20
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results. Valid values: If NextToken is empty, no next page exists. You must specify the token that is obtained from the previous query as the value of NextToken.	CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAIldD2UAAAAACjMDLgAAADFTNzMyZDMwMzAzMDY5NzQzNDM0NmI3NzM2NjUzNzc4NzM2YTc0NjYzOTYz****
RequestId	string	The request ID.	378A80E9-4262-5D8E-8D62-0969E52D7358
TotalCount	integer	The total number of entries returned.	100

Examples

Sample success responses

JSONformat

{
  "LoadBalancers": [
    {
      "AddressIpVersion": "IPv4",
      "CreateTime": "2024-08-05 18:24:07",
      "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
}

Error codes

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