ListLoadBalancers - Server Load Balancer - Alibaba Cloud Documentation Center

Queries the configurations of load balancer 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

alb:ListLoadBalancers

get

LoadBalancer

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

LoadBalancer

acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

None

Request parameters

Parameter	Type	Required	Description	Example
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. Valid values: You do not need to specify this parameter for the first request. If a subsequent call is required, set the value to the NextToken value returned from the previous call.	ettsdgfsdgdfg
MaxResults	integer	No	The number of entries to return on each page. Valid values: 1 to 100. Default value: 20.	true
ZoneId	string	No	The ID of the zone where the Application Load Balancer instance is deployed. You can call the DescribeZones operation to query information about the zones.	cn-hangzhou-a
LoadBalancerStatus	string	No	The state of the Application Load Balancer instance. Valid values: Inactive: The instance is disabled. Listeners of the instance do not forward traffic. Active: The instance is running. Provisioning: The instance is being created. Configuring: The instance is being configured. CreateFailed: The instance failed to be created. You are not charged for the instance. You can only delete the instance. The system automatically deletes instances that failed to be created within one day.	Active
LoadBalancerBussinessStatus	string	No	The service status of the Application Load Balancer instance. Valid values: Abnormal: The instance is not working as expected. Normal: The instance is working as expected.	Normal
LoadBalancerIds	array	No	The instance IDs. You can specify up to 20 Application Load Balancer instance IDs.
	string	No	The instance ID.	alb-o9ulmq5hgn68jk****
LoadBalancerNames	array	No	The instance names. You can specify up to 10 instance names.
	string	No	The name of the instance. The name must be 2 to 128 characters in length, start with a letter or a Chinese character, and can contain digits, periods (.), underscores (_), and hyphens (-).	alb-instance-test
VpcIds	array	No	The ID of the virtual private cloud (VPC) to which the Application Load Balancer instance belongs. You can specify up to 10 VPC IDs.
	string	No	The ID of the VPC to which the Application Load Balancer instance belongs.	vpc-bp1b49rqrybk45nio****
Tag	array<object>	No	The tags of the instances.
	object	No	The tag of the 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://`.	alueTest
AddressType	string	No	The type of the IP address that the Application Load Balancer instance uses to provide services. Valid values: Internet: The ALB instance uses a public IP address. The domain name of the ALB instance is resolved to the public IP address. Therefore, the ALB instance can be accessed over the Internet. Intranet: The ALB instance uses a private IP address. The domain name of the ALB instance is resolved to the private IP address. Therefore, the ALB instance can be accessed in the VPC where the ALB instance is deployed.	Intranet
PayType	string	No	The billing method of the instance. Valid value: PostPay (default): The instance is billed on a pay-as-you-go basis.	PostPay
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmxazb4ph****
AddressIpVersion	string	No	The protocol version. Valid values: IPv4: IPv4 DualStack: dual-stack	IPv4
Ipv6AddressType	string	No	The type of the IPv6 address that the Application Load Balancer instance uses to provide services. Valid values: Internet: The ALB instance uses a public IP address. The domain name of the ALB instance is resolved to the public IP address. Therefore, the ALB instance can be accessed over the Internet. Intranet: The ALB instance uses a private IP address. The domain name of the ALB instance is resolved to the private IP address. Therefore, the ALB instance can be accessed in the VPC where the ALB instance is deployed.	Intranet
DNSName	string	No	The domain name.	alb-95qnr2itwu9orb****.cn-hangzhou.alb.aliyuncs.com

Response elements

Element	Type	Description	Example
	object	The configurations of the Application Load Balancer instance.
LoadBalancers	array<object>	The list of Application Load Balancer instances.
	array<object>	The details of the Application Load Balancer instance.
AccessLogConfig	object	The configuration of the access log.
LogProject	string	The Log Service project.	sls-setter
LogStore	string	The Logstore.	test
AddressAllocatedMode	string	The mode of the IP address. Valid values: Fixed: The ALB instance uses a static IP address. Dynamic: A dynamic IP address is allocated to the ALB instance in each zone.	Fixed
AddressType	string	The type of IP address that the ALB instance uses to provide services. Valid values: Internet: The ALB instance uses a public IP address. The domain name of the ALB instance is resolved to the public IP address. Therefore, the ALB instance can be accessed over the Internet. Intranet: The ALB instance uses a private IP address. The domain name of the ALB instance is resolved to the private IP address. Therefore, the ALB instance can be accessed in the VPC where the ALB instance is deployed.	Intranet
BandwidthPackageId	string	The ID of the Internet Shared Bandwidth instance that is associated with the Internet-facing ALB instance.	cbwp-bp1vevu8h3ieh****
CreateTime	string	The time when the resource was created.	2022-07-02T02:49:05Z
DNSName	string	The domain name.	alb-95qnr2itwu9orb****.cn-hangzhou.alb.aliyuncs.com
DeletionProtectionConfig	object	The deletion protection configuration.
Enabled	boolean	Indicates whether deletion protection is enabled. Valid values: true: enabled. false: disabled.	true
EnabledTime	string	The time when deletion protection was enabled.	2022-08-02T02:49:05Z
LoadBalancerBillingConfig	object	The billing configuration of the ALB instance.
PayType	string	The billing method. Valid value: PostPay: pay-as-you-go.	PostPay
LoadBalancerBussinessStatus	string	The service status of the ALB instance. Valid values: Abnormal: The instance is not working as expected. Normal: The instance is working as expected.	Normal
LoadBalancerEdition	string	The edition of the ALB instance. Different editions have different limits and billing methods. Valid values: Basic: Basic Edition. Standard: Standard Edition. StandardWithWaf: WAF-enabled Edition.	Standard
LoadBalancerId	string	The ID of the Application Load Balancer instance.	alb-o9ulmq5hgn68jk****
LoadBalancerName	string	The name of the ALB instance.	alb-instance-test
LoadBalancerOperationLocks	array<object>	The configuration of the configuration lock.
	object	The details of the configuration lock.
LockReason	string	The reason for the lock. This parameter is valid only if LoadBalancerBussinessStatus is set to Abnormal.	欠费
LockType	string	The type of the lock. Valid values: SecurityLocked: The instance is locked for security reasons. RelatedResourceLocked: The instance is locked due to a correlated resource. FinancialLocked: The instance is locked due to overdue payments. ResidualLocked: The instance is locked because it is faulty.	FinancialLocked
LoadBalancerStatus	string	The state of the Application Load Balancer instance. Valid values: Inactive: The instance is disabled. Listeners of the instance do not forward traffic. Active: The instance is running. Provisioning: The instance is being created. Configuring: The instance is being configured. CreateFailed: The instance failed to be created.	Active
ModificationProtectionConfig	object	The configuration of modification protection.
Reason	string	The reason for enabling modification protection. The reason must be 2 to 128 characters in length, start with a letter or a Chinese character, and can contain digits, periods (.), underscores (_), and hyphens (-). This parameter is returned only if Status is set to ConsoleProtection.	托管实例
Status	string	The status of modification protection. Valid values: NonProtection: Modification protection is disabled. If you specify a value for Reason, the value is cleared. ConsoleProtection: Modification protection is enabled. If you specify a value for Reason, the value takes effect. Note If you set the value to ConsoleProtection, you cannot modify the instance configuration in the Application Load Balancer console. However, you can call API operations to modify the instance configuration.	ConsoleProtection
ResourceGroupId	string	The ID of the resource group.	rg-atstuj3rtop****
Tags	array<object>	The list of tags.
	object	The tag.
Key	string	The tag key of the instance.	KeyTest
Value	string	The tag value of the instance.	alueTest
VpcId	string	The ID of the VPC to which the Application Load Balancer instance belongs.	vpc-bp1b49rqryhk45nio****
AddressIpVersion	string	The protocol version. Valid values: IPv4: IPv4 DualStack: dual-stack	DualStack
Ipv6AddressType	string	The type of the IPv6 address that the Application Load Balancer instance uses to provide services. Valid values: Internet: The ALB instance uses a public IP address. The domain name of the ALB instance is resolved to the public IP address. Therefore, the ALB instance can be accessed over the Internet. Intranet: The ALB instance uses a private IP address. The domain name of the ALB instance is resolved to the private IP address. Therefore, the ALB instance can be accessed in the VPC where the ALB instance is deployed.	Intranet
SecurityGroupIds	array	The security groups to which the Application Load Balancer instance is added.
	string	The security group to which the Application Load Balancer instance is added.	sg-2zejdtxxpu8c9tny****
MaxResults	integer	The number of entries returned on each page.	20
NextToken	string	The pagination token that is used in the next request to retrieve a new page of results. Valid values: If NextToken is empty, it indicates that no next query is to be sent. If a value is returned for NextToken, the value is the token that determines the start point of the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	The request ID.	365F4154-92F6-4AE4-92F8-7FF34B540710
TotalCount	integer	The number of entries returned.	100

Examples

Success response

JSON format

{
  "LoadBalancers": [
    {
      "AccessLogConfig": {
        "LogProject": "sls-setter",
        "LogStore": "test"
      },
      "AddressAllocatedMode": "Fixed",
      "AddressType": "Intranet",
      "BandwidthPackageId": "cbwp-bp1vevu8h3ieh****",
      "CreateTime": "2022-07-02T02:49:05Z",
      "DNSName": "alb-95qnr2itwu9orb****.cn-hangzhou.alb.aliyuncs.com",
      "DeletionProtectionConfig": {
        "Enabled": true,
        "EnabledTime": "2022-08-02T02:49:05Z"
      },
      "LoadBalancerBillingConfig": {
        "PayType": "PostPay"
      },
      "LoadBalancerBussinessStatus": "Normal",
      "LoadBalancerEdition": "Standard",
      "LoadBalancerId": "alb-o9ulmq5hgn68jk****",
      "LoadBalancerName": "alb-instance-test",
      "LoadBalancerOperationLocks": [
        {
          "LockReason": "欠费",
          "LockType": "FinancialLocked"
        }
      ],
      "LoadBalancerStatus": "Active",
      "ModificationProtectionConfig": {
        "Reason": "托管实例",
        "Status": "ConsoleProtection"
      },
      "ResourceGroupId": "rg-atstuj3rtop****",
      "Tags": [
        {
          "Key": "KeyTest",
          "Value": "alueTest"
        }
      ],
      "VpcId": "vpc-bp1b49rqryhk45nio****",
      "AddressIpVersion": "DualStack",
      "Ipv6AddressType": "Intranet",
      "SecurityGroupIds": [
        "sg-2zejdtxxpu8c9tny****"
      ]
    }
  ],
  "MaxResults": 20,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "TotalCount": 100
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.