Load Balancer Stats

GET

/api/v1/appliances/load-balancers/{lb_id}/

curl --request GET \
  --url 'https://api.e2enetworks.com/myaccount/api/v1/appliances/load-balancers/{lb_id}/?project_id=<PROJECT_ID>&apikey=<API_KEY>&location=<LOCATION>' \
  --header 'Authorization: Bearer <API_TOKEN>'

import requests

response = requests.get(
    "https://api.e2enetworks.com/myaccount/api/v1/appliances/load-balancers/{lb_id}/",
    params={"project_id": "<PROJECT_ID>", "apikey": "<API_KEY>", "location": "<LOCATION>"},
    headers={"Authorization": "Bearer <API_TOKEN>"},
)
print(response.json())

const url = new URL("https://api.e2enetworks.com/myaccount/api/v1/appliances/load-balancers/{lb_id}/");
url.search = new URLSearchParams({ project_id: "<PROJECT_ID>", apikey: "<API_KEY>", location: "<LOCATION>" });

const response = await fetch(url, {
  method: "GET",
  headers: { "Authorization": "Bearer <API_TOKEN>" },
});
console.log(await response.json());

Returns live HAProxy runtime statistics for a single load balancer, grouped into frontends, backends, and servers. The fields mirror the HAProxy stats CSV (sessions, bytes in/out, queue depth, response code counts, health-check status, and so on) and are useful for building custom dashboards. For historical time-series data use Historical Data instead.

Parameters

Path Parameters

lb_id

required

integer

The id of the load balancer, as returned by the List Load Balancers endpoint.

Example

Query Parameters

project_id

required

integer

Identifier of the project to scope the request to. Required integer project ID.

Example

<PROJECT_ID>

apikey

required

string

API key used to authenticate the request

Example

<API_KEY>

location

required

string

Region of the load balancer.

Example

<LOCATION>

Responses

200

Successful response

application/json

Live HAProxy statistics. frontends, backends, and servers are arrays whose objects mirror the HAProxy stats CSV columns (only the commonly used columns are shown here).

object

code

integer

data

object

frontends

Array<object>

object

pxname

Proxy (frontend) name.

string

svname

string

scur

Current sessions.

integer

smax

Max sessions seen.

integer

stot

Total sessions.

integer

bin

Bytes in.

integer

bout

Bytes out.

integer

status

string

hrsp_2xx

integer

hrsp_4xx

integer

hrsp_5xx

integer

backends

Backend-level stats (same column set as frontends).

Array<object>

object

pxname

string

svname

string

status

string

servers

Per-server stats within each backend.

Array<object>

object

pxname

string

svname

string

status

string

errors

object

message

string

Example

{
  "code": 200,
  "data": {
    "frontends": [
      {
        "pxname": "http-in",
        "svname": "FRONTEND",
        "scur": 1,
        "smax": 2,
        "stot": 2,
        "bin": 186,
        "bout": 217,
        "status": "OPEN",
        "hrsp_2xx": 0,
        "hrsp_4xx": 0,
        "hrsp_5xx": 1
      }
    ],
    "backends": [
      {
        "pxname": "backend-group-1",
        "svname": "BACKEND",
        "status": "UP"
      }
    ],
    "servers": [
      {
        "pxname": "backend-group-1",
        "svname": "C3-8GB-853",
        "status": "UP"
      }
    ]
  },
  "message": "Success"
}