Cluster alerts requests
Cluster alert requests
| Method |
Path |
Description |
| GET |
/v1/cluster/alerts |
Get all cluster alerts |
| GET |
/v1/cluster/alerts/{alert} |
Get a specific cluster alert |
Get all cluster alerts
GET /v1/cluster/alerts
Get all alert states for the cluster object.
Required permissions
Request
Example HTTP request
GET /cluster/alerts
| Key |
Value |
Description |
| Host |
cnm.cluster.fqdn |
Domain name |
| Accept |
application/json |
Accepted media type |
Query parameters
| Field |
Type |
Description |
| ignore_settings |
boolean |
Retrieve updated alert state regardless of the cluster’s alert_settings. When not present, a disabled alert will always be retrieved as disabled with a false state. (optional) |
Response
Returns a hash of alert objects and their states.
Example JSON body
{
"cluster_too_few_nodes_for_replication": {
"change_time": "2014-12-22T11:48:00Z",
"change_value": {
"state": false
},
"enabled": true,
"state": "off",
"severity": "WARNING",
},
"..."
}
Status codes
| Code |
Description |
| 200 OK |
No error |
Get cluster alert
GET /v1/cluster/alerts/{alert}
Get a cluster alert state.
Required permissions
Request
Example HTTP request
GET /cluster/alerts/cluster_too_few_nodes_for_replication
| Key |
Value |
Description |
| Host |
cnm.cluster.fqdn |
Domain name |
| Accept |
application/json |
Accepted media type |
Query parameters
| Field |
Type |
Description |
| ignore_settings |
boolean |
Retrieve updated alert state regardless of the cluster’s alert_settings. When not present, a disabled alert will always be retrieved as disabled with a false state. (optional) |
Response
Returns an alert object.
Example JSON body
{
"change_time": "2014-12-22T11:48:00Z",
"change_value": {
"state": false
},
"enabled": true,
"state": "off",
"severity": "WARNING",
}
Status codes