Get Load Balancer Metrics Summary

GET

/gateway/{gateway_id}/metrics_summary/

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

import requests

response = requests.get(
    "https://api.e2enetworks.com/myaccount/api/v1/gpu/gateway/{gateway_id}/metrics_summary/",
    params={"project_id": "<PROJECT_ID>", "location": "<LOCATION>", "apikey": "<API_KEY>"},
    headers={"Authorization": "Bearer <API_TOKEN>"},
)
print(response.json())

const url = new URL("https://api.e2enetworks.com/myaccount/api/v1/gpu/gateway/{gateway_id}/metrics_summary/");
url.search = new URLSearchParams({ project_id: "<PROJECT_ID>", location: "<LOCATION>", apikey: "<API_KEY>" });

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

Returns the current value of every metric of the Load Balancer, for the interval. The metrics are those of its type; see List Load Balancer Metrics. A value that cannot be read comes back as "0.00".

Parameters

Path Parameters

gateway_id

required

integer

Load Balancer ID

Query Parameters

project_id

required

integer

Project ID

interval

string

default: 5m

Allowed values: 5m 15m 30m 1h 3h 6h 12h

How far back to look. Default 5m.

active_iam

integer

Active IAM ID (To access contact person account) Find your Active IAM ID here

location

required

string

Allowed values: Delhi Chennai

Location

Responses

200

One entry per metric key

application/json

object

code

integer

message

string

data

One entry per metric key, shown here for two of them.

object

request_count

object

metric_name

string

description

string

current_value

The value, as a text with 2 decimals.

string

unit

string

healthy_backends

object

metric_name

string

description

string

current_value

string

unit

string

errors

object

Example

{
  "code": 200,
  "message": "Success",
  "data": {
    "request_count": {
      "metric_name": "Requests / sec",
      "description": "Total requests per second received by the load balancer",
      "current_value": "12.50",
      "unit": "req/s"
    },
    "healthy_backends": {
      "metric_name": "Healthy Backends",
      "description": "Backend targets currently passing health checks",
      "current_value": "2.00",
      "unit": "hosts"
    }
  },
  "errors": {}
}

400

interval is not one of the allowed values. A missing or invalid project ID also gives 400 with errors “Project ID is missing or invalid”.

application/json

object

code

integer

message

string

data

object

errors

string

Example

{
  "code": 400,
  "message": "Bad Request",
  "data": {},
  "errors": "Invalid interval value"
}

404

No Load Balancer with that ID in the project and region.

application/json

object

code

integer

message

string

data

object

errors

string

Example

{
  "code": 404,
  "message": "Bad Request",
  "data": {},
  "errors": "Gateway not found"
}