Skip to main content

Get Node Server Health Metrics

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.

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

Path parameters

  • master_node_idPathintegerrequired

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

    • required
    • must be a valid node ID
    example320000

Query parameters

  • intervalQueryintegeroptional

    Look-back window for the metrics, in seconds.

    • optional
    • positive integer (seconds)
    • defaults to 3600 (1 hour)
    example3600
  • project_idQueryintegerrequired

    Identifier of the project to scope the request to. Required integer project ID.

    • required
    • must be a valid integer project ID
    example{{project_id}}
  • apikeyQuerystringrequired

    API key used to authenticate the request.

    • required
    • non-empty string
    example{{api_key}}
  • locationQuerystringrequired

    Region of the node.

    • required
    • must be a valid region name (e.g., Delhi, Chennai)
    example{{location}}

Responses

200Successful response
object

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.

codeinteger
example200
dataobject
errorsobject
messagestring
exampleSuccess