DescribeLoadBalancers - Server Load Balancer - Alibaba Cloud Documentation Center

You can query created SLB 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

slb:DescribeLoadBalancers

get

*LoadBalancer

acs:slb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Classic Load Balancer (CLB) instance. You can call the DescribeRegions operation to query region IDs.	cn-hangzhou
ServerId	string	No	The ID of the backend server that is added to the CLB instance.	i-2zebcbq******
AddressIPVersion	string	No	The IP version. Set the value to ipv4 or ipv6.	ipv4
LoadBalancerStatus	string	No	The state of the instance. Valid values: inactive: The instance is stopped. Listeners of an instance in this state do not forward traffic. active: The instance is running. This is the default state of an instance after it is created. locked: The instance is locked. An instance enters the locked state after it expires. This state lasts for seven days. You cannot perform operations on the instance. The instance does not forward traffic, but its IP address and other configurations are retained.	active
LoadBalancerId	string	No	The ID of the CLB instance. You can specify up to 10 IDs, separated by commas (,).	lb-bp1b6c719dfa****
LoadBalancerName	string	No	The name of the CLB instance. The name must be 1 to 80 characters in length. It must start with a letter or a Chinese character. It can contain letters, digits, periods (.), underscores (_), and hyphens (-). You can specify up to 10 names. Separate multiple names with commas (,).	test
ServerIntranetAddress	string	No	The internal IP address of the added backend server. You can specify multiple IP addresses. Separate them with commas (,).	10.XX.XX.102
AddressType	string	No	The network type of the CLB instance. Valid values: internet: An Internet-facing CLB instance. The system assigns a public IP address to the instance. The instance can forward requests from the Internet. intranet: An internal-facing CLB instance. The system assigns a private IP address to the instance. The instance can forward requests only within internal networks.	intranet
InternetChargeType	string	No	The billing method of the Internet-facing CLB instance. Valid values: paybybandwidth: pay-by-bandwidth. paybytraffic: pay-by-data-transfer.	paybytraffic
VpcId	string	No	The ID of the virtual private cloud (VPC) to which the CLB instance belongs.	vpc-bp1aevy8sof****
VSwitchId	string	No	The ID of the vSwitch to which the CLB instance belongs.	vsw-bp12mw1f8k3****
NetworkType	string	No	The network type of the internal-facing CLB instance. Valid values: vpc: a VPC. classic: a classic network.	vpc
Address	string	No	The service address of the CLB instance.	192.168.XX.XX
MasterZoneId	string	No	The ID of the primary zone of the CLB instance.	cn-hangzhou-b
SlaveZoneId	string	No	The ID of the secondary zone of the CLB instance. The multi-zone feature is not available for Alibaba Finance Cloud users.	cn-hangzhou-d
Tags	string	No	The tags that are added to the CLB instance. The value is a JSON dictionary that consists of tag keys and tag values. You can add up to 10 tags in each request.	[{"tagKey":"Key1","tagValue":"Value1"}]
PayType	string	No	The billing method of the CLB instance. Valid values: PayOnDemand: pay-as-you-go.	PayOnDemand
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmxazb4p****
PageNumber	integer	No	The page number of the page to return.	1
PageSize	integer	No	The number of entries to return on each page. Valid values: 1 to 100. Note If you set PageSize, you must also set PageNumber.	50
Tag	array<object>	No	The list of tags.
	object	No	The list of tags.
Key	string	No	The key of tag N. Valid values of N: 1 to 20. 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://`.	FinanceDept
Value	string	No	The value of tag N. Valid values of N: 1 to 20. The tag value can be an empty string. The tag value can be up to 128 characters in length. It cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	FinanceJoshua

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	8B9DB03B-ED39-5DB8-9C9F-1ED5F548D61E
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned on the current page.	50
TotalCount	integer	The total number of instances that meet the filter conditions.	1
LoadBalancers	object
LoadBalancer	array<object>	The list of CLB instances.
	array<object>	The list of CLB instances.
VpcId	string	The ID of the VPC in which the internal-facing CLB instance is deployed.	vpc-25dvzy9f8****
CreateTimeStamp	integer	The timestamp that indicates when the instance was created.	1504147745000
LoadBalancerId	string	The ID of the CLB instance.	lb-bp1b6c719dfa****
CreateTime	string	The time when the instance was created. The time is in the `YYYY-MM-DDThh:mm:ssZ` format.	2021-12-02T02:49:05Z
PayType	string	The billing method of the CLB instance. Valid values: PayOnDemand: pay-as-you-go.	PayOnDemand
AddressType	string	The network type of the instance. Valid values: internet: An Internet-facing CLB instance. The system assigns a public IP address to the instance. The instance can forward requests from the Internet. intranet: An internal-facing CLB instance. The system assigns a private IP address to the instance. The instance can forward requests only within internal networks.	intranet
NetworkType	string	The network type of the internal-facing CLB instance. Valid values: vpc: a VPC. classic: a classic network.	vpc
AddressIPVersion	string	The IP version. Valid values: ipv4 and ipv6.	ipv4
LoadBalancerName	string	The name of the CLB instance.	lb-bp1o94dp5i6ea****
Bandwidth	integer	The peak bandwidth of the listener. Unit: Mbit/s.	-1
Address	string	The service address of the CLB instance.	100.XX.XX.28
SlaveZoneId	string	The ID of the secondary zone of the instance.	cn-hangzhou-d
MasterZoneId	string	The ID of the primary zone of the instance.	cn-hangzhou-b
InternetChargeTypeAlias	string	The billing method of the Internet-facing CLB instance. Valid values: paybybandwidth: pay-by-bandwidth. paybytraffic: pay-by-data-transfer	paybybandwidth
LoadBalancerSpec	string	The specification of the CLB instance. Note Pay-by-data-transfer instances have no specification. The default value slb.lcu.elastic is returned.	slb.s1.small
RegionId	string	The region ID of the CLB instance.	cn-hangzhou
ModificationProtectionReason	string	The reason why the configuration read-only mode is enabled. The reason must be 1 to 80 characters in length. It must start with a letter or a Chinese character. It can contain letters, digits, periods (.), underscores (_), and hyphens (-). Note This parameter is valid only if `ModificationProtectionStatus` is set to ConsoleProtection.	ManagedInstance
ModificationProtectionStatus	string	The status of the configuration read-only mode: NonProtection: The configuration read-only mode is disabled. After you disable the mode, the value of `ModificationProtectionReason` is cleared. ConsoleProtection: The configuration read-only mode is enabled. Note If the value is ConsoleProtection, the configuration read-only mode is enabled. You cannot modify the instance configuration in the CLB console. However, you can call API operations to modify the instance configuration.	ConsoleProtection
VSwitchId	string	The ID of the vSwitch in the VPC where the internal-facing CLB instance is deployed.	vsw-255ecr****
LoadBalancerStatus	string	The state of the CLB instance. Valid values: inactive: The instance is stopped. Listeners of an instance in this state do not forward traffic. active: The instance is running. This is the default state of an instance after it is created. locked: The instance is locked.	active
ResourceGroupId	string	The ID of the resource group.	rg-atstuj3r****
InternetChargeType	string	The billing method of the Internet-facing instance. Valid values: 3: pay-by-bandwidth. 4: pay-by-data-transfer.	3
DeleteProtection	string	Indicates whether deletion protection is enabled for the CLB instance. Valid values: on: enabled. off: disabled.	off
RegionIdAlias	string	The name of the region where the CLB instance is deployed.	cn-hangzhou
Tags	object
Tag	array<object>	The list of tags
	object	The list of tags
TagValue	string	The tag value.	testvalue
TagKey	string	The tag key.	testkey

Examples

Success response

JSON format

{
  "RequestId": "8B9DB03B-ED39-5DB8-9C9F-1ED5F548D61E",
  "PageNumber": 1,
  "PageSize": 50,
  "TotalCount": 1,
  "LoadBalancers": {
    "LoadBalancer": [
      {
        "VpcId": "vpc-25dvzy9f8****",
        "CreateTimeStamp": 1504147745000,
        "LoadBalancerId": "lb-bp1b6c719dfa****",
        "CreateTime": "2021-12-02T02:49:05Z",
        "PayType": "PayOnDemand",
        "AddressType": "intranet",
        "NetworkType": "vpc",
        "AddressIPVersion": "ipv4",
        "LoadBalancerName": "lb-bp1o94dp5i6ea****",
        "Bandwidth": -1,
        "Address": "100.XX.XX.28",
        "SlaveZoneId": "cn-hangzhou-d",
        "MasterZoneId": "cn-hangzhou-b",
        "InternetChargeTypeAlias": "paybybandwidth",
        "LoadBalancerSpec": "slb.s1.small",
        "RegionId": "cn-hangzhou",
        "ModificationProtectionReason": "ManagedInstance",
        "ModificationProtectionStatus": "ConsoleProtection",
        "VSwitchId": "vsw-255ecr****",
        "LoadBalancerStatus": "active",
        "ResourceGroupId": "rg-atstuj3r****",
        "InternetChargeType": "3",
        "DeleteProtection": "off",
        "RegionIdAlias": "cn-hangzhou",
        "Tags": {
          "Tag": [
            {
              "TagValue": "testvalue",
              "TagKey": "testkey"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidTag	The specified tags is invalid.
400	TooManyResult	fuzzy query retrieve too many instances.
400	LocationServiceTimeout	Location service connection timeout. Please try again later.
403	UnauthorizedRegion	The specified region of is not authorized.	The specified region of is not authorized.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.