Get Cluster Monitoring

GET

/tenant_clusters/{tenant_cluster_id}/monitoring/

curl --request GET \
  --url 'https://api.e2enetworks.com/myaccount/api/v1/gpu/tenant_clusters/{tenant_cluster_id}/monitoring/?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/tenant_clusters/{tenant_cluster_id}/monitoring/",
    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/tenant_clusters/{tenant_cluster_id}/monitoring/");
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 cluster’s health summary and one row for each node, with its CPU, memory, disk, network, load, and uptime over the time range. Send page_no and per_page together to page the node rows; the summary always covers every node.

This covers the nodes only, not what runs inside the cluster.

Parameters

Path Parameters

tenant_cluster_id

required

integer

Kubernetes cluster ID, as returned by List Kubernetes Clusters.

Query Parameters

interval

string

default: 5m

Allowed values: 5m 15m 1h 6h 1d 7d 1mn

The time range the metrics cover. 1mn is 30 days.

page_no

integer

The page number from which you want your page search results to be displayed.

per_page

integer

Number of results per page

project_id

required

integer

Project ID

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 health summary and node rows.

application/json

object

code

integer

data

object

cluster_health

object

cluster_id

integer

cluster_name

string

status

string

Allowed values: queued cluster_provisioning worker_joining worker_joined ready failed deleting deleted

region

string

api_server_endpoint

string

nullable

total_nodes

integer

ready_nodes

integer

nodes_state_count

object

key

additional properties

integer

nodes_role_count

object

key

additional properties

integer

provisioned_cpu

number

nullable

total_memory

number

nullable

total_disk

number

nullable

metrics

Cluster totals for each node measure except load and uptime: percentages are averaged, weighted by each node’s size; network traffic is added up.

object

key

additional properties

any

nodes

Array<object>

One node’s figures over the time range. Every measured value can be null, which means it was not reported, not that it was zero.

object

hostname

string

role

string

state

string

pool_name

string

nullable

sku_name

string

nullable

cpu

Cores.

object

provisioned

number

nullable

used

number

nullable

memory

object

provisioned

number

nullable

used

number

nullable

ephemeral_storage

object

provisioned

number

nullable

used

number

nullable

cpu_utilization

Percent.

number

nullable

memory_utilization

Percent.

number

nullable

disk_utilization

Percent.

number

nullable

load_average

number

nullable

network_rx_bytes

number

nullable

network_tx_bytes

number

nullable

uptime

string

nullable

uptime_seconds

number

nullable

errors

object

message

string

total_page_number

Only when page_no and per_page are sent.

integer

total_count

Only when page_no and per_page are sent.

integer

Example

{
  "code": 200,
  "data": {
    "cluster_health": {
      "cluster_id": 103,
      "cluster_name": "tir-k8s-prod",
      "status": "queued",
      "region": "Delhi",
      "api_server_endpoint": "https://203.0.113.20:6443",
      "total_nodes": 5,
      "ready_nodes": 5,
      "nodes_state_count": {
        "ready": 5
      },
      "nodes_role_count": {
        "master": 3,
        "worker": 2
      },
      "provisioned_cpu": 20,
      "total_memory": 38,
      "total_disk": 245.5
    },
    "nodes": [
      {
        "hostname": "tir-k8s-prod-app-workers-7d9f8-abcde",
        "role": "worker",
        "state": "ready",
        "pool_name": "app-workers",
        "sku_name": "C3.8GB",
        "cpu": {
          "provisioned": 4,
          "used": 1.2
        },
        "memory": {
          "provisioned": 7.6,
          "used": 3.1
        },
        "ephemeral_storage": {
          "provisioned": 49.1,
          "used": 12.4
        },
        "cpu_utilization": 30.5,
        "memory_utilization": 40.8,
        "disk_utilization": 25.3,
        "load_average": 0.85,
        "network_rx_bytes": 1048576,
        "network_tx_bytes": 524288,
        "uptime": "2 days, 3 hours, 10 minutes",
        "uptime_seconds": 184200
      }
    ]
  },
  "errors": {},
  "message": "Success",
  "total_page_number": 1,
  "total_count": 5
}