ON THIS PAGE
GET /health/metrics/system_metrics
SUMMARY Gets the list of system metrics.
Gets the list of system metrics.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
filter |
query |
Optional |
String |
text/plain |
Optional - This parameter is used to restrict the elements in a list base on the contents of various fields. |
fields |
query |
Optional |
String |
text/plain |
Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
Range |
header |
Optional |
String |
text/plain |
Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero. |
HTTP Response Code | Unique Code | Description |
---|---|---|
200 |
A list of system metrics defined by the SystemMetric DTO. |
|
500 |
1020 |
Internal Server Error. |
Response Description
- metric_id - String - Unique ID of the metric.
- time_resolution - Long - Time frequency in milliseconds at which the metric is polled.
- enabled - String - Boolean to enable or disable the metric.
Response Sample
[ { "enabled": true, "metric_id": "String", "time_resolution": 42 } ]