DescribeLoadBalancerMonitorData

1. API Description

This API is used to query the monitor data of a load balancer, including Concurrent Connections (Counts/min), CPS (Counts/s), Network Throughput and Data Transfer.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
loadBalancerId	Yes	String	Load balancer ID.
listenerId	No	String	Load balance listener ID.
metricType	Yes	LoadBalancerMonitorMetricType	Monitor metric type.
startTime	Yes	String	Start time. Format: yyyy-MM-ddTHH:mm:ssZ.
endTime	Yes	String	End time. Format: yyyy-MM-ddTHH:mm:ssZ.

3. Output Parameters

Parameter Name	Type	Description
requestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.
maxValue	Float	Maximum value.
minValue	Float	Minimum value.
avgValue	Float	Average value.
metrics	Array of MetricValue	All data set.

4. Code Example

Example 1

1. Query Concurrent Connections data of a load balancer.

POST /api/v2/zlb HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeLoadBalancerMonitorData
<Common Request Params>

Request：
{
   "loadBalancerId": "< loadBalancerId >",
   "metricType": "NEW_CONNECTIONS",
   "startTime": "2025-06-25T01:55:00Z",
   "endTime": "2025-06-25T07:55:00Z"
}

Response：
{
 "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
 "response": {
   "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
   "maxValue": 1.2,
   "minValue": 1.2,
   "avgValue": 1.2,
   "metrics": [
     {
       "time": "2025-06-25T01:55:00Z",
       "value": 1.2
     }
   ]
 }
}

Example 2

2. Query Concurrent Connections data of a load balance listener.

POST /api/v2/zlb HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeLoadBalancerMonitorData
<Common Request Params>

Request：
{
   "loadBalancerId": "< loadBalancerId >",
   "listenerId": "< listenerId >",
   "metricType": "NEW_CONNECTIONS",
   "startTime": "2025-06-25T01:55:00Z",
   "endTime": "2025-06-25T07:55:00Z"
}

Response：
{
 "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
 "response": {
   "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
   "maxValue": 1.2,
   "minValue": 1.2,
   "avgValue": 1.2,
   "metrics": [
     {
       "time": "2025-06-25T01:55:00Z",
       "value": 1.2
     }
   ]
 }
}

5. Developer Resources

Zenlayer Cloud API 2.0 SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

HTTP Status Code	Error Code	Description
404	INVALID_LB_NOT_FOUND	Load balancer does not exist.