DescribeServerLoadBalancerMonitor API Reference for ELB Metrics - ENS - Alibaba Cloud - ENS

Queries request monitoring data of an ESLB instance.

Operation description

API call frequency: 100 calls per second.
Per-user call frequency: 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:DescribeServerLoadBalancerMonitor

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	Yes	The start time in the format of yyyy-MM-dd HH:mm:ss.	2024-09-15 16:00:00
EndTime	string	Yes	The end time. The maximum interval between StartTime and EndTime cannot exceed 24 hours.	2024-09-15 17:00:00
LoadBalancerId	string	Yes	The load balancing instance ID.	lb-5sc1s9zrui8lpb8u7cl4f****

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request。	AAE90880-4970-4D81-A534-A6C0F3631F74
ServerLoadBalancerMonitorData	array<object>	The array of objects.
	object	The monitoring data.
LoadBalancerId	string	The load balancing instance ID.	lb-5sc1s9zrui8lpb8u7cl4f****
LoadBalancerName	string	The load balancing instance name.	esk-edge-service-lb-a34****
EnsRegionId	string	The ID of the edge zone.	cn-wuxi-10
LoadBalancerSpec	string	The load balancing instance specification.	elb.s2.medium
Vip	string	The virtual IP address (VIP) of the instance.	10.0****
Vni	integer	The tunnel ID.	3018
Acc	integer	The total number of requests.	30
Reqs2xx	integer	The number of requests with 2xx HTTP status codes.	25
Reqs3xx	integer	The number of requests with 3xx HTTP status codes.	0
Reqs4xx	integer	The number of requests with 4xx HTTP status codes.	5
Reqs5xx	integer	The number of requests with 5xx HTTP status codes.	0
RtAvg	integer	The average request latency. Unit: milliseconds.	1404
BizTime	string	The log business time. The log collection granularity is 1 minute.	2024-09-15 16:00:00

Examples

Success response

JSON format

{
  "RequestId": "AAE90880-4970-4D81-A534-A6C0F3631F74",
  "ServerLoadBalancerMonitorData": [
    {
      "LoadBalancerId": "lb-5sc1s9zrui8lpb8u7cl4f****",
      "LoadBalancerName": "esk-edge-service-lb-a34****",
      "EnsRegionId": "cn-wuxi-10",
      "LoadBalancerSpec": "elb.s2.medium",
      "Vip": "10.0****",
      "Vni": 3018,
      "Acc": 30,
      "Reqs2xx": 25,
      "Reqs3xx": 0,
      "Reqs4xx": 5,
      "Reqs5xx": 0,
      "RtAvg": 1404,
      "BizTime": "2024-09-15 16:00:00\n"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.
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.