Get Node Server Health Metrics

GET

/api/v1/nodes/{master_node_id}/monitor/server-health/

curl --request GET \
  --url 'https://api.e2enetworks.com/myaccount/api/v1/nodes/{master_node_id}/monitor/server-health/?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/nodes/{master_node_id}/monitor/server-health/",
    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/nodes/{master_node_id}/monitor/server-health/");
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 time-series health metrics for a single cluster node - memory, disk and CPU utilisation, disk IOPS, and per-NIC network in/out throughput. Each metric is a { labels, results } pair (labels are timestamps, results are values). The path takes a node id (e.g. the master_node_id from List / Detail, or a node id from Monitoring Nodes). Use interval to set the look-back window in seconds.

Parameters

Path Parameters

master_node_id

required

integer

The node id whose metrics to fetch (e.g. master_node_id from List / Detail).

Example

Query Parameters

interval

integer

Look-back window for the metrics, in seconds.

Example

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 node.

Example

<LOCATION>

Responses

200

Successful response

application/json

Time-series health metrics for the node. Each metric is a { labels, results } pair where labels are timestamps and results are the metric values at those timestamps.

object

code

integer

data

object

memory

object

labels

Array<string>

results

Array<number>

cpu

CPU utilisation series ({ labels, results }).

object

disk

Disk utilisation series ({ labels, results }).

object

disk_iops

Disk IOPS series ({ labels, results }).

object

network

Per-NIC network in/out throughput series.

object

errors

object

message

string

Example

{
  "code": 200,
  "data": {
    "memory": {
      "labels": [
        "01:27PM",
        "01:37PM"
      ],
      "results": [
        42.5,
        43.1
      ]
    }
  },
  "message": "Success"
}