GET /metrics/perf
Prometheus text exposition of the newest performance samples of every host, VM and datastore the caller can see (all of them for an anonymous scrape when metrics_anonymous is set).
API: metrics
Operations of the metrics tag of the native REST API.
Performance counters and samples of hosts, VMs and datastores (20 s realtime, 5 min to 1 day rollups)
GET
GET /v1/metrics/counters
Lists the counter catalogue.
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | OK | array of CounterView |
GET /v1/metrics/entities/{id}/available
Counters (and instances) with data for an entity at an interval.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | Host, VM or datastore id |
interval | query | integer (int32) or null | Sampling period: 20 (default for hosts and VMs), 300, 1800, 7200 or 86400. |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | OK | AvailableView |
| 404 | Not found (or not visible to the caller) | ErrorBody |
GET /v1/metrics/intervals
Lists the sampling intervals and their collection levels.
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | OK | array of IntervalView |
| 503 | Temporarily unavailable (not the leader, or the service is off) | ErrorBody |
GET /v1/metrics/query
Queries samples (URL parameters).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
entity | query | string | yes | Comma-separated entity ids. |
counter | query | string | yes | Comma-separated counter names or ids. |
interval | query | integer (int32) or null | Sampling period. | |
start | query | string or null | Exclusive start (RFC 3339). | |
end | query | string or null | Inclusive end (RFC 3339). | |
instance | query | string or null | Instance selector ("", "*" or a name). | |
maxSamples | query | integer (int32) or null | Newest N samples per series. |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | OK | MetricsQueryResponse |
| 400 | Invalid argument; the error body names the field | ErrorBody |
| 404 | Not found (or not visible to the caller) | ErrorBody |
POST /v1/metrics/query
Queries samples.
Request body
application/json: MetricsQueryRequest
| Name | Type | Required | Description |
|---|---|---|---|
counters | array of string | yes | Counter names (cpu.usage.average) or ids ("2"). |
end | string or null | Inclusive end (RFC 3339); default now. | |
entities | array of string | yes | Entity ids (vm-42, host-1, datastore-3). |
instance | string or null | "" the aggregate (default), "*" every instance and the aggregate, or one instance. | |
interval | integer (int32) or null | Sampling period (20, 300, 1800, 7200, 86400); default 20 for hosts and VMs, 300 for datastores. | |
maxSamples | integer (int32) or null | Newest N samples per series. | |
start | string or null | Exclusive start (RFC 3339); default as far back as the interval keeps. |
Responses
| Status | Description | Schema |
|---|---|---|
| 200 | OK | MetricsQueryResponse |
| 400 | Invalid argument; the error body names the field | ErrorBody |
| 404 | Not found (or not visible to the caller) | ErrorBody |
Version 0.1.