Use DescribeLoadBalancerAttribute to query Edge Load Balancer instance attributes - ENS

Retrieves the details of a specified load balancer instance.

Operation description

API Call Rate: 100 requests/second.
Per-user Call Rate: 10 requests/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:DescribeLoadBalancerAttribute

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
LoadBalancerId	string	Yes	The ID of the load balancer instance.	lb-5rcvo1n1t3hykfhhjwjgq****

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
LoadBalancerId	string	The ID of the Load Balancer instance.	lb-5rcvo1n1t3hykfhhjwjgqp****
LoadBalancerName	string	The name of the Load Balancer instance.	example
LoadBalancerStatus	string	The status of the Load Balancer instance. Valid values: Active: The instance's Listeners can forward traffic based on the configured rules. Inactive: The instance's Listeners do not forward traffic.	Active
EnsRegionId	string	The ID of the ENS region.	cn-chengdu-telecom
Address	string	The service address of the Load Balancer instance.	192.168.XX.XX
NetworkId	string	The ID of the network.	n-5rwbi3g9zvgxcsiufwhw8****
VSwitchId	string	The ID of the vSwitch.	vsw-5s78m2pdr9osa0j64bn78****
Bandwidth	integer	The peak bandwidth of the Load Balancer instance. A value of -1 indicates that the bandwidth is unlimited.	-1
LoadBalancerSpec	string	The specification of the Load Balancer instance.	elb.s2.medium
CreateTime	string	The creation time of the Load Balancer instance, in UTC.	2019-05-21T12:22:00Z
EndTime	string	The expiration time of the Load Balancer instance.	2020-05-21T12:22:00Z
ListenerPorts	array	The frontend ports used by the Load Balancer instance.
	string	The frontend port used by the Load Balancer instance.	80
BackendServers	array<object>	A list of Backend Servers.
	object	A Backend Server.
ServerId	string	The ID of the Backend Server instance.	i-5vb5h5njxiuhn48a****
Ip	string	The IP address of the Backend Server.	192.168.XX.XX
Port	string	The port used by the Backend Server.	0
Type	string	The type of the Backend Server.	ens
Weight	integer	The weight of the Backend Server.	100
ListenerPortsAndProtocols	array<object>	The frontend ports and protocols used by the Load Balancer instance.
	object	Details about a frontend port and protocol.
ListenerPort	integer	The Listener port.	8080
ListenerProtocol	string	The Listener protocol.	tcp
Description	string	The description of the Listener.	test
ListenerForward	string	Indicates whether Listener Forwarding is enabled.	off
ForwardPort	integer	The destination Listener port to which traffic is forwarded.	0
BackendServerPort	integer	The port used by the Backend Servers. The value must be between 1 and 65535.	6000
AddressIPVersion	string	The IP version of the Load Balancer instance. Valid values: `ipv4` or `ipv6`.	ipv4
PayType	string	The billing method. Valid values: Prepaid: The subscription model. PostPaid: The pay-as-you-go model.	PostPaid
LoadBalancerType	string
AddressType	string

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "LoadBalancerId": "lb-5rcvo1n1t3hykfhhjwjgqp****",
  "LoadBalancerName": "example",
  "LoadBalancerStatus": "Active",
  "EnsRegionId": "cn-chengdu-telecom",
  "Address": "192.168.XX.XX",
  "NetworkId": "n-5rwbi3g9zvgxcsiufwhw8****",
  "VSwitchId": "vsw-5s78m2pdr9osa0j64bn78****",
  "Bandwidth": -1,
  "LoadBalancerSpec": "elb.s2.medium",
  "CreateTime": "2019-05-21T12:22:00Z",
  "EndTime": "2020-05-21T12:22:00Z",
  "ListenerPorts": [
    "80"
  ],
  "BackendServers": [
    {
      "ServerId": "i-5vb5h5njxiuhn48a****",
      "Ip": "192.168.XX.XX\n",
      "Port": "0",
      "Type": "ens",
      "Weight": 100
    }
  ],
  "ListenerPortsAndProtocols": [
    {
      "ListenerPort": 8080,
      "ListenerProtocol": "tcp",
      "Description": "test",
      "ListenerForward": "off",
      "ForwardPort": 0,
      "BackendServerPort": 6000
    }
  ],
  "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.