List Load Balancer Metrics

GET

/gateway/metrics_list/

curl --request GET \
  --url 'https://api.e2enetworks.com/myaccount/api/v1/gpu/gateway/metrics_list/?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/metrics_list/",
    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/metrics_list/");
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 metrics a Load Balancer reports, with their keys, names and descriptions. Use a metric_key as metric_name in Get Load Balancer Metric. The HTTP and HTTPS list has 12 metrics; the TCP list has 6.

Parameters

Query Parameters

project_id

required

integer

Project ID

lb_type

string

Allowed values: L4 L7

L4 returns the TCP list. Any other value, or none, returns the HTTP and HTTPS list.

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

The metrics

application/json

object

code

integer

message

string

data

Array<object>

object

metric_key

request_count, rate_limited, active_connections, throughput_in, throughput_out, latency_p90, avg_response_time, error_rate, success_rate, throttle_rate, cpu_utilization, healthy_backends for HTTP and HTTPS. active_connections, connection_rate, throughput_in, throughput_out, cpu_utilization, healthy_backends for TCP.

string

metric_name

string

description

string

errors

object

Example

{
  "code": 200,
  "message": "Success",
  "data": [
    {
      "metric_key": "request_count",
      "metric_name": "Requests / sec",
      "description": "Total requests per second received by the load balancer"
    }
  ],
  "errors": {}
}

400

The project ID is missing or is not a number.

application/json

object

code

integer

message

string

data

object

errors

string

Example

{
  "code": 400,
  "message": "Bad Request",
  "data": {},
  "errors": "Project ID is missing or invalid"
}