Query ELB instances using DescribeLoadBalancers - ENS - Alibaba Cloud - ENS

Queries the list of created load balancing instances.

Operation description

API call rate: 100 calls per second.
Per-user call rate: 10 calls per second.

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

ens:DescribeLoadBalancers

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
EnsRegionId	string	No	The ENS node ID.	cn-guangzhou-10
ServerId	string	No	The instance ID of the backend server.	i-5f67ffjc004wwz0t****
LoadBalancerStatus	string	No	The listener status of the load balancing instance. Valid values: Active: The listeners of the instance can forward received traffic based on rules. InActive: The listeners of the instance no longer forward received traffic.	InActive
LoadBalancerId	string	No	The ID of the load balancing instance.	lb-5q73cv04zeyh43lh74lp4****
LoadBalancerName	string	No	The name of the load balancing instance.	example
NetworkId	string	No	The network ID.	n-5s9ayrxsd9hszrlt5fgv2****
VSwitchId	string	No	The vSwitch ID.	vsw-5sy773iy25rulsmgskmba****
Address	string	No	The service address of the load balancing instance.	10.0.XX.XX
EnsRegionIds	array	No	The list of ENS node IDs.
	string	No	The ENS node ID.	cn-chengdu-telecom-4
PageNumber	integer	No	The page number of the list. Default value: 1.	1
PageSize	integer	No	The number of entries per page for a paged query. Default value: 10. Valid values: 10 to 100.	100
LoadBalancerType	string	No	The type of the load balancing instance.

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	The page number of the list.	1
PageSize	integer	The number of entries per page for a paged query. Default value: 10. Valid values: 10 to 100.	100
TotalCount	integer	The total number of entries in the list.	1
LoadBalancers	object
LoadBalancer	array<object>	The list of load balancing instances returned in array format.
	object	The list of load balancing instances returned in array format.
LoadBalancerId	string	The ID of the ELB instance.	lb-5snthcyu1x10g7tywj7iu****
LoadBalancerName	string	The name of the ELB instance.	example
LoadBalancerStatus	string	The status of the ELB instance. Valid values: Active: The listeners of the instance can forward received traffic based on the rules. Inactive: The listeners of the instance no longer forward received traffic.	InActive
Address	string	The service address of the ELB instance.	10.10.XX.XX
EnsRegionId	string	The ID of the ENS node.	cn-wuhan-telecom
NetworkId	string	The ID of the network.	n-5rz0rj1caexauilpsjx0w****
VSwitchId	string	The ID of the vSwitch.	vsw-5rllcjb3ol6duzjdnbm1om****
CreateTime	string	The time when the ELB instance was created. The time is displayed in UTC.	2021-05-06T11:13:41Z
AddressIPVersion	string	The IP version. Valid values: ipv4 and ipv6.	ipv4
PayType	string	The billing method of the instance. Valid values: PrePaid: subscription PostPaid: pay-as-you-go. This is currently the only supported billing method.	PostPaid
LoadBalancerType	string	The type of the ELB instance.
AddressType	string	The address type.

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "PageSize": 100,
  "TotalCount": 1,
  "LoadBalancers": {
    "LoadBalancer": [
      {
        "LoadBalancerId": "lb-5snthcyu1x10g7tywj7iu****",
        "LoadBalancerName": "example",
        "LoadBalancerStatus": "InActive",
        "Address": "10.10.XX.XX",
        "EnsRegionId": "cn-wuhan-telecom",
        "NetworkId": "n-5rz0rj1caexauilpsjx0w****",
        "VSwitchId": "vsw-5rllcjb3ol6duzjdnbm1om****",
        "CreateTime": "2021-05-06T11:13:41Z",
        "AddressIPVersion": "ipv4",
        "PayType": "PostPaid",
        "LoadBalancerType": "",
        "AddressType": ""
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
400	ens.interface.error	Failed to call API.
400	NoPermission	Permission denied.
400	Invalid%s	The specified parameter %s is invalid.
400	Missing%s	You must specify the parameter %s.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.