Get Cluster Health

GET

/tenant_clusters/{tenant_cluster_id}/monitoring/health/

curl --request GET \
  --url 'https://api.e2enetworks.com/myaccount/api/v1/gpu/tenant_clusters/{tenant_cluster_id}/monitoring/health/?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/health/",
    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/health/");
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 on its own, without the node rows: node counts by state and role, the resources measured, and figures for the whole 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.

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.

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

errors

object

message

string

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
    }
  },
  "errors": {},
  "message": "Success"
}