Query Load Balancer Configs with ListLoadBalancers API - ALB - Alibaba Cloud - Server Load Balancer

Queries the configuration of 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 or if no next query exists. If a next query 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
ZoneId	string	No	The zone ID of the Application Load Balancing (ALB) instance. You can invoke the DescribeZones operation to query the active zone information.	cn-hangzhou-a
LoadBalancerStatus	string	No	The instance status of the Application Load Balancing (ALB) instance. Valid values: Inactive: The instance is stopped. Listeners no longer forward traffic. Active: The instance is running. Provisioning: The instance is being created. Configuring: Upgrade/Downgrade in progress. CreateFailed: The instance failed to be created. In this case, no fees are incurred. You can only delete the instance. The system cleans up instances that failed to be created in the last day by default.	Active
LoadBalancerBussinessStatus	string	No	The business status of the Application Load Balancing (ALB) instance. Valid values: Abnormal: The instance is abnormal. Normal: The instance is running as expected.	Normal
LoadBalancerIds	array	No	The list of instance IDs. You can specify up to 20 Application Load Balancing (ALB) instance IDs.
	string	No	The instance ID.	alb-o9ulmq5hgn68jk****
LoadBalancerNames	array	No	The list of instance names. You can specify up to 10 instance names.
	string	No	The 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 or a Chinese character.	alb-instance-test
VpcIds	array	No	The VPC IDs of the Application Load Balancing (ALB) instances. You can specify up to 10 VPC IDs.
	string	No	The VPC ID of the Application Load Balancing (ALB) instance.	vpc-bp1b49rqrybk45nio****
Tag	array<object>	No	The instance tags.
	object	No	The instance tag structure.
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 address type of the 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 can be accessed over the Internet. Intranet: The load balancing instance has only a private IP. The DNS domain name is resolved to the private IP. Therefore, the instance can be accessed only within the internal network environment of the VPC where the load balancing instance is deployed.	Intranet
PayType	string	No	The billing method of the instance. Valid values: PostPay (default): the pay-as-you-go billing method.	PostPay
ResourceGroupId	string	No	The resource group ID.	rg-acfmxazb4ph****
AddressIpVersion	string	No	The protocol version. Valid values: IPv4: IPv4. DualStack: dual stack.	IPv4
Ipv6AddressType	string	No	The IPv6 address type of the Application Load Balancing (ALB) 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 can be accessed over the Internet. Intranet: The load balancing instance has only a private IP. The DNS domain name is resolved to the private IP. Therefore, the instance can be accessed only within the internal network environment of the VPC where the load balancing instance is deployed.	Intranet
DNSName	string	No	The DNS domain name.	alb-95qnr2itwu9orb****.cn-hangzhou.alb.aliyuncs.com

Response elements

Element	Type	Description	Example
	object	The configuration information of the Application Load Balancing (ALB) instances.
LoadBalancers	array<object>	The list of Application Load Balancing (ALB) instances.
	array<object>	The Application Load Balancing (ALB) instance structure.
AccessLogConfig	object	The access log configuration.
LogProject	string	The log project.	sls-setter
LogStore	string	The Logstore.	test
AddressAllocatedMode	string	The address mode. Valid values: Fixed: Fixed IP mode. The instance uses a fixed IP address. Dynamic: Dynamic IP mode. An IP address is dynamically assigned to each zone.	Fixed
AddressType	string	The address type of the load balancing instance. Valid values: Internet: The load balancing instance has a public IP address. The DNS domain name is resolved to the public IP address, so the instance can be accessed over the Internet. Intranet: The load balancing instance has only a private IP address. The DNS domain name is resolved to the private IP, so the instance can be accessed only from the internal network of the VPC where the load balancing instance is deployed.	Intranet
BandwidthPackageId	string	The ID of the Internet Shared Bandwidth instance associated with the Internet-facing load balancer instance.	cbwp-bp1vevu8h3ieh****
CreateTime	string	The time when the resource was created. The time is in ISO 8601 format in UTC. Format: YYYY-MM-DDTHH:mm:ssZ.	2022-07-02T02:49:05Z
DNSName	string	The DNS domain name.	alb-95qnr2itwu9orb****.cn-hangzhou.alb.aliyuncs.com
DeletionProtectionConfig	object	The deletion protection configuration.
Enabled	boolean	The deletion protection status. Valid values: true: Enabled. false: Disabled.	true
EnabledTime	string	The time when deletion protection was enabled. The time is in ISO 8601 format in UTC. Format: YYYY-MM-DDTHH:mm:ssZ.	2022-08-02T02:49:05Z
LoadBalancerBillingConfig	object	The billing configuration of the load balancing instance.
PayType	string	The billing type. Valid values: PostPay: pay-as-you-go billing method.	PostPay
LoadBalancerBussinessStatus	string	The business status of the load balancing instance. Valid values: Abnormal: abnormal. Normal: Normal.	Normal
LoadBalancerEdition	string	The edition of the load balancing instance. Different editions have different feature limits and billing policy. Valid values: Basic: Basic Edition. Standard: Standard Edition. StandardWithWaf: WAF-enhanced Edition.	Standard
LoadBalancerId	string	The Application Load Balancing (ALB) instance ID.	alb-o9ulmq5hgn68jk****
LoadBalancerName	string	The name of the load balancing instance.	alb-instance-test
LoadBalancerOperationLocks	array<object>	The operation lock configuration of the load balancing instance.
	object	The operation lock structure of the load balancing instance.
LockReason	string	The reason for the lock. This parameter is valid only when LoadBalancerBussinessStatus is Abnormal.	Overdue payment
LockType	string	The type of the lock. Valid values: SecurityLocked: locked due to security reasons. RelatedResourceLocked: locked due to associated resources. FinancialLocked: locked due to overdue payment. ResidualLocked: locked due to residual resources.	FinancialLocked
LoadBalancerStatus	string	The status of the Application Load Balancing (ALB) instance. Valid values: Inactive: stopped. The listeners of the instance no longer forward traffic. Active: running. Provisioning: being created. Configuring: Upgrade/Downgrade in progress. CreateFailed: failed to be created.	Active
ModificationProtectionConfig	object	The modification protection configuration.
Reason	string	The reason for enabling modification protection. The value must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The value must start with a letter. This parameter is returned only when Status is set to ConsoleProtection.	Managed Instance
Status	string	The modification protection status of the Application Load Balancing (ALB) instance. Valid values: NonProtection: Modification protection is disabled. If Reason is configured, Reason is forcefully cleared. ConsoleProtection: Console-based modification protection is enabled. If Reason is configured, Reason takes effect. Note When the value is ConsoleProtection, you cannot modify the instance configuration in the load balancing console, but you can call API operations to modify the instance configuration.	ConsoleProtection
ResourceGroupId	string	The resource group ID.	rg-atstuj3rtop****
Tags	array<object>	The list of tags.
	object	The tag structure.
Key	string	The tag key of the instance.	KeyTest
Value	string	The tag value of the instance.	alueTest
VpcId	string	The VPC ID of the Application Load Balancing (ALB) instance.	vpc-bp1b49rqryhk45nio****
AddressIpVersion	string	The protocol version. Valid values: IPv4: IPv4. DualStack: dual-stack.	DualStack
Ipv6AddressType	string	The IPv6 network address type of the Application Load Balancing (ALB) instance. Valid values: Internet: public. The load balancing instance has a public IP address. The DNS domain name is resolved to the public IP address, so the instance can be accessed over the Internet. Intranet: private. The load balancing instance has only a private IP address. The DNS domain name is resolved to the private IP, so the instance can be accessed only from the internal network of the VPC where the load balancing instance is deployed.	Intranet
SecurityGroupIds	array	The security groups to which the Application Load Balancing (ALB) instance is added.
	string	The security group to which the Application Load Balancing (ALB) instance is added.	sg-2zejdtxxpu8c9tny****
MaxResults	integer	The number of entries per page in a paginated query.	20
NextToken	string	Indicates whether a next query exists. Valid values: If NextToken is empty, no next query exists. If NextToken is returned, the value indicates the token for the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	The request ID.	365F4154-92F6-4AE4-92F8-7FF34B540710
TotalCount	integer	The total 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": "Managed Instance",
        "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.