Node alerts requests
Node alert requests
This documentation applies to Redis Software versions 7.4.x.
| Method |
Path |
Description |
| GET |
/v1/nodes/alerts |
Get all alert states for all nodes |
| GET |
/v1/nodes/alerts/{uid} |
Get all alert states for a node |
| GET |
/v1/nodes/alerts/{uid}/{alert} |
Get node alert state |
Get all alert states
GET /v1/nodes/alerts
Get all alert states for all nodes.
Required permissions
Request
Example HTTP request
GET /nodes/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 node UIDs and the alert states for each node.
Example JSON body
{
"1": {
"node_cpu_utilization": {
"change_time": "2014-12-22T10:42:00Z",
"change_value": {
"cpu_util": 2.500000000145519,
"global_threshold": "1",
"state": true
},
"enabled": true,
"state": true,
"severity": "WARNING"
},
"..."
},
"..."
}
Status codes
| Code |
Description |
| 200 OK |
No error |
Get node alert states
GET /v1/nodes/alerts/{int: uid}
Get all alert states for a node.
Required permissions
Request
Example HTTP request
GET /nodes/alerts/1
| 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 for a specific node.
Example JSON body
{
"node_cpu_utilization": {
"change_time": "2014-12-22T10:42:00Z",
"change_value": {
"cpu_util": 2.500000000145519,
"global_threshold": "1",
"state": true
},
"enabled": true,
"state": true,
"severity": "WARNING",
},
"..."
}
Status codes
Get node alert state
GET /v1/nodes/alerts/{int: uid}/{alert}
Get a node alert state.
Required permissions
Request
Example HTTP request
GET /nodes/alerts/1/node_cpu_utilization
| 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-22T10:42:00Z",
"change_value": {
"cpu_util": 2.500000000145519,
"global_threshold": "1",
"state": true
},
"enabled": true,
"state": true,
"severity": "WARNING",
}
Status codes