DescribeLoadBalancerListenMonitor API Reference - ENS

Queries monitoring data of an edge load balancer (ELB) instance.

Operation description

up to 100 times per second per account.
up to 10 times per second per user.

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:DescribeLoadBalancerListenMonitor

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	Yes	The beginning of the time range to query.	2024-01-15 16:00:00
EndTime	string	Yes	The end of the time range to query.	2024-01-30 08:00:00
LoadBalancerId	string	Yes	The ID of the ELB instance.	lb-5q73cv04zeyh43lh74lp4****
VPort	string	Yes	The virtual IP address (VIP) port of the ELB instance.	80
Proto	string	No	The network protocol, such as tcp or udp.	tcp

Response elements

Element	Type	Description	Example
	object	Schema of Response.
RequestId	string	Id of the request.	C0003E8B-B930-4F59-ADC0-0E209A9012A8
LoadBalancerMonitorListenData	array<object>	The TCP/UDP monitoring data of the ELB instance.
	object	The monitoring data.
LoadBalancerId	string	The ID of the ELB instance.	lb-5q73cv04zeyh43lh74lp4****
EnsRegionId	string	The ID of the node to which the ELB instance belongs.	cn-dongguan-9
Vip	string	The virtual IP address (VIP) of the instance.	10.8.****
Vni	string	The ID of the tunnel.	53284
VPort	string	The VIP port of the ELB instance.	80
Proto	string	The network protocol.	tcp
Conns	string	The number of new connections.	37150
ActConns	string	The number of active connections.	80285
InActConns	string	The number of inactive connections.	16322
DropConns	string	The number of dropped connections.	10
InPkts	string	The number of inbound packets.	12
OutPkts	string	The number of outbound packets.	34
InDropPkts	string	The number of dropped inbound packets.	27
OutDropPkts	string	The number of dropped outbound packets.	76
InBytes	string	The inbound traffic.	67532
OutBytes	string	The outbound traffic.	5155487
InDropBytes	string	The dropped inbound traffic.	324
OutDropBytes	string	The dropped outbound traffic.	0
ValidRsNum	string	The number of available servers that are attached to the monitored ELB instance.	2
InValidRsNum	string	The number of unavailable servers that are attached to the monitored ELB instance.	0
BizTime	string	The business time.	2024-01-15 16:03:00

Examples

Success response

JSON format

{
  "RequestId": "C0003E8B-B930-4F59-ADC0-0E209A9012A8",
  "LoadBalancerMonitorListenData": [
    {
      "LoadBalancerId": "lb-5q73cv04zeyh43lh74lp4****",
      "EnsRegionId": "cn-dongguan-9",
      "Vip": "10.8.****",
      "Vni": "53284",
      "VPort": "80",
      "Proto": "tcp",
      "Conns": "37150",
      "ActConns": "80285",
      "InActConns": "16322",
      "DropConns": "10",
      "InPkts": "12",
      "OutPkts": "34",
      "InDropPkts": "27",
      "OutDropPkts": "76",
      "InBytes": "67532",
      "OutBytes": "5155487",
      "InDropBytes": "324",
      "OutDropBytes": "0",
      "ValidRsNum": "2",
      "InValidRsNum": "0",
      "BizTime": "2024-01-15 16:03:00"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.