Mount Point: /api/v12/hosts/{hostId}/metrics


This operation has been deprecated. This endpoint is not supported as of v6. Use the timeseries API instead. To get all metrics for a host with the timeseries API use the query:

'select * where hostId = $HOST_ID'.

To get specific metrics for a host use a comma-separated list of the metric names as follows:

'select $METRIC_NAME1, $METRIC_NAME2 where hostId = $HOST_ID'.

For more information see the tsquery language documentation.

Fetch metric readings for a host.

By default, this call will look up all metrics available for the host. If only specific metrics are desired, use the metrics parameter.

By default, the returned results correspond to a 5 minute window based on the provided end time (which defaults to the current server time). The from and to parameters can be used to control the window being queried. A maximum window of 3 hours is enforced.

When requesting a "full" view, aside from the extended properties of the returned metric data, the collection will also contain information about all metrics available for the role, even if no readings are available in the requested window.

Host metrics also include per-network interface and per-storage device metrics. Since collecting this data incurs in more overhead, query parameters can be used to choose which network interfaces and storage devices to query, or to these metrics altogether.

Storage metrics are collected at different levels; for example, per-disk and per-partition metrics are available. The "storageIds" parameter can be used to filter specific storage IDs.

In the returned data, the network interfaces and storage IDs can be identified by looking at the "context" property of the metric objects.


name description type default
hostId The host's ID. path
from Start of the period to query. query
to End of the period to query. query now
queryNw Whether to query for network interface metrics. query true
ifs Network interfaces to query for metrics (default = all). query
queryStorage Whether to query for storage metrics. query true
storageIds Storage context IDs to query for metrics (default = all). query
metrics Filter for which metrics to query. query
view The view of the data to materialize, either "summary" or "full". query summary

Response Body

element: metricList

List of readings from the monitors.