GET /customAlerts/metrics
Use this method to return a list of metrics that can be used in custom alert rules.
Note
This REST API requires Lenovo XClarity Orchestrator v1.3 or later.
Authentication
Authentication with username and password is required.
Resource URI
GET https://{orchestrator_server_IP}/customAlerts/metrics
Query parameters
None
Request body
None
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
Response body
When the request is successful, the following attributes are returned. If the request fails, standard message attributes are returned (see Status messages).
| Attributes | Type | Description | ||
|---|---|---|---|---|
| results | Array of objects | Information about each metric | ||
| metric | String | Metric name | ||
| sampleRate | Integer | Rate, in seconds, at which the metrics values are recorded | ||
| _links | Object | Resource URI (see Links) | ||
The following example is returned if the request is successful.
{
"results": [{
"metric": "cpu_temp",
"sampleRate": "60"
},
{
"metric": "cpu_utilization",
"sampleRate": "30"
}],
"_links": {
"rel": "self",
"uri": "/api/v1/customAlerts/metrics"
}
}
Give documentation feedback