DescribeLoadBalancers - Server Load Balancer - Alibaba Cloud Documentation Center

Queries Classic Load Balancer (CLB) 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 ID of the region where the CLB instance is deployed. You can call the DescribeRegions operation to query the most recent region list.	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 that is used by the CLB instance. Valid values: ipv4 and ipv6.	ipv4
LoadBalancerStatus	string	No	The status of the CLB instance. Valid values: inactive: The CLB instance is disabled. CLB instances in the inactive state do not forward traffic. active: The CLB instance runs as expected. By default, newly created CLB instances are in the active state. locked: The CLB instance is locked. After a CLB instance expires, it is locked for seven days. A locked CLB instance cannot forward traffic and you cannot perform operations on the locked CLB instance. However, other settings such as the IP address are retained.	active
LoadBalancerId	string	No	The ID of the CLB instance. You can specify up to 10 IDs. Separate multiple IDs with commas (,).	lb-bp1b6c719dfa****
LoadBalancerName	string	No	The name of the CLB instance. The name must be 1 to 80 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter. You can specify up to 10 names. Separate multiple names with commas (,).	test
ServerIntranetAddress	string	No	The private IP address of the backend server that is added to the CLB instance. You can specify multiple IP addresses. Separate multiple IP addresses with commas (,).	10.XX.XX.102
AddressType	string	No	The network type of the CLB instance. Valid values: internet: After an Internet-facing CLB instance is created, the system assigns a public IP address to the CLB instance. Then, the CLB instance can forward requests over the Internet. intranet: After an internal-facing CLB instance is created, the system assigns a private IP address to the CLB instance. Then, the CLB instance can forward requests only over internal networks.	intranet
InternetChargeType	string	No	The metering method of Internet data transfer. 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: VPC Classic: classic network	vpc
Address	string	No	The IP address that the CLB instance uses to provide services.	192.168.XX.XX
MasterZoneId	string	No	The ID of the primary zone to which the CLB instance belongs.	cn-hangzhou-b
SlaveZoneId	string	No	The ID of the secondary zone to which the CLB instance belongs. CLB instances on Alibaba Finance Cloud do not support cross-zone deployment.	cn-hangzhou-d
Tags	string	No	The tags that are added to the CLB instance. The tags must be key-value pairs that are contained in a JSON dictionary. You can specify up to 10 tags in each call.	[{"tagKey":"Key1","tagValue":"Value1"}]
PayType	string	No	The billing method of the CLB instance. Valid values: Set the value to PayOnDemand.	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 specify the PageSize parameter, you must also specify the PageNumber parameter.	50
Tag	array<object>	No	The tags.
	object	No	The tag.
Key	string	No	The key of the tag. You can specify up to 20 tag keys. The tag key cannot be an empty string. The tag key must be 1 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 the tag. You can specify up to 20 tag values. The tag value can be an empty string. The tag value can be at most 128 characters in length and cannot start with `acs:` or `aliyun`. It cannot contain `http://` or `https://`.	FinanceJoshua

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	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 number of instances returned.	1
LoadBalancers	object
LoadBalancer	array<object>	An array of CLB instances.
	array<object>	The CLB instances.
VpcId	string	The ID of the VPC in which the internal-facing CLB instance was deployed.	vpc-25dvzy9f8****
CreateTimeStamp	integer	The timestamp when the instance was created.	1504147745000
LoadBalancerId	string	The ID of the CLB instance.	lb-bp1b6c719dfa****
CreateTime	string	The time when the CLB instance was created. The time follows the `YYYY-MM-DDThh:mm:ssZ` format.	2021-12-02T02:49:05Z
PayType	string	The billing method of the CLB instance. PayOnDemand is returned, which indicates the pay-as-you-go billing method.	PayOnDemand
AddressType	string	The network type of the CLB instance. Valid values: internet: After an Internet-facing CLB instance is created, the system assigns a public IP address to the CLB instance. Then, the CLB instance can forward requests over the Internet. intranet: After an internal-facing CLB instance is created, the system assigns a private IP address to the CLB instance. Then, the CLB instance can forward requests only over internal networks.	intranet
NetworkType	string	The network type of the internal-facing CLB instance. Valid values: vpc: VPC Classic: classic network	vpc
AddressIPVersion	string	The IP version that is used by the CLB instance. Valid values: ipv4 and ipv6.	ipv4
LoadBalancerName	string	The name of the CLB instance.	lb-bp1o94dp5i6ea****
Bandwidth	integer	The maximum bandwidth of the listener. Unit: Mbit/s.	-1
Address	string	The endpoint of the CLB instance.	100.XX.XX.28
SlaveZoneId	string	The ID of the secondary zone to which the CLB instance belongs.	cn-hangzhou-d
MasterZoneId	string	The ID of the primary zone to which the CLB instance belongs.	cn-hangzhou-b
InternetChargeTypeAlias	string	The metering method of Internet data transfer. Valid values: paybybandwidth: pay-by-bandwidth. paybytraffic: pay-by-data-transfer.	paybybandwidth
LoadBalancerSpec	string	The specification of the CLB instance. Note Pay-as-you-go CLB instances are not subject to specifications. slb.lcu.elastic is returned by default.	slb.s1.small
RegionId	string	The ID of the region where the CLB instance was deployed.	cn-hangzhou
ModificationProtectionReason	string	The reason why the configuration read-only mode was enabled. The reason must be 1 to 80 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The reason must start with a letter. Note This parameter takes effect only when you set the `ModificationProtectionStatus` parameter to ConsoleProtection.	ManagedInstance
ModificationProtectionStatus	string	Indicates whether the configuration read-only mode is enabled for the CLB instance. Valid values: NonProtection: The configuration read-only mode is disabled. In this case, you cannot specify the ModificationProtectionReason parameter. If you specify the `ModificationProtectionReason` parameter, the value is cleared. ConsoleProtection: The configuration read-only mode is enabled. Note If you set this parameter to ConsoleProtection, you cannot modify the configurations of the CLB instance in the CLB console. However, you can call API operations to modify the configurations of the CLB instance.	ConsoleProtection
VSwitchId	string	The ID of the vSwitch to which the internal-facing CLB instance belongs.	vsw-255ecr****
LoadBalancerStatus	string	The status of the CLB instance. Valid values: inactive: The CLB instance is disabled. CLB instances in the inactive state do not forward traffic. active: The CLB instance runs as expected. By default, newly created CLB instances are in the active state. locked: The CLB instance is locked.	active
ResourceGroupId	string	The ID of the resource group.	rg-atstuj3r****
InternetChargeType	string	The metering method of the Internet-facing CLB instance. Valid values: 3: pay-by-bandwidth (paybybandwidth). 4: pay-by-data-transfer (paybytraffic).	3
DeleteProtection	string	Indicates whether deletion protection is enabled for the CLB instance. Valid values: on: Deletion protection is enabled. off: Deletion protection is disabled.	off
RegionIdAlias	string	The region where the CLB instance was deployed.	cn-hangzhou
Tags	object
Tag	array<object>	The tags.
	object	The tag.
TagValue	string	The value of the tag.	testvalue
TagKey	string	The key of the tag.	testkey
InstanceChargeType	string		PayBySpec

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"
            }
          ]
        },
        "InstanceChargeType": "PayBySpec"
      }
    ]
  }
}

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.