DescribeLoadBalancerAttribute - ENS - Alibaba Cloud Documentation Center

Queries detailed information about an Edge Load Balancer (ELB) instance.

Operation description

You can call this operation up to 100 times per second.
You can call this operation up to 10 times per second per account.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ens:DescribeLoadBalancerAttribute	get	All Resources ``	none	none

Request parameters

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

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
LoadBalancerId	string	The ID of the ELB instance.	lb-5rcvo1n1t3hykfhhjwjgqp****
LoadBalancerName	string	The name of the ELB instance.	example
LoadBalancerStatus	string	The status of the ELB instance. Valid values: Active (default): The listener for the instance can forward the received traffic based on the rule. InActive: The listener for the instance does not forward the received traffic.	Active
EnsRegionId	string	The ID of the ENS node.	cn-chengdu-telecom
Address	string	The IP address that the Edge Load Balancer (ELB) instance uses to provide services.	192.168XX.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 ELB. The default value is -1, which indicates that the bandwidth is unlimited.	-1
LoadBalancerSpec	string	The specifications of the ELB instance.	elb.s2.medium
CreateTime	string	The time when the ELB instance was created. The time is displayed in UTC.	2019-05-21T12:22:00Z
EndTime	string	The time when the ELB instance was disabled.	2020-05-21T12:22:00Z
ListenerPorts	array	The frontend ports that are used by the ELB instance.
listenerPort	string	The frontend port that is used by the ELB instance.	80
BackendServers	array<object>	The list of backend servers.
rs	object	The list of backend servers.
ServerId	string	The ID of the backend server.	i-5vb5h5njxiuhn48a****
Ip	string	The IP address of the backend server.	192.168.XX.XX
Port	string	The port that is used by the backend server.	0
Type	string	The type of backend server.	ens
Weight	integer	The weight of the backend server.	100
ListenerPortsAndProtocols	array<object>	The frontend ports and protocols that are used by the ELB instance.
listener	object	The frontend ports and protocols that are used by the ELB instance.
ListenerPort	integer	The listener port of the instance.	8080
ListenerProtocol	string	The listener protocol of the instance.	tcp
Description	string	The description of the listener.	test
ListenerForward	string	Indicates whether the listener is enabled.	off
ForwardPort	integer	The destination listening port to which requests are forwarded.	0
AddressIPVersion	string	The IP version of the ELB instance. Valid values: ipv4 and ipv6.	ipv4
PayType	string	The billing method. Valid values: PrePaid: subscription. PostPaid: pay-as-you-go. Only this billing method is supported.	PostPaid

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "LoadBalancerId": "lb-5rcvo1n1t3hykfhhjwjgqp****",
  "LoadBalancerName": "example",
  "LoadBalancerStatus": "Active",
  "EnsRegionId": "cn-chengdu-telecom",
  "Address": "192.168XX.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
    }
  ],
  "AddressIPVersion": "ipv4",
  "PayType": "PostPaid"
}

Error codes

HTTP status code	Error code	Error message
400	ens.interface.error	An error occurred while call the API.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-01-22	The Error code has changed	View Change Details