Alerts

Get all database alerts {#get-all-bdbs-alerts}

GET /v1/bdbs/alerts

Get all alert states for all databases.

Required permissions

Request {#get-all-request}

Example HTTP request

GET /v1/bdbs/alerts 

Request headers

Response {#get-all-response}

Returns a hash of alert UIDs and the [alerts]({{< relref "/operate/rs/7.22/references/rest-api/objects/alert" >}}) states for each database.

Example JSON body

{
    "1": {
        "bdb_size": {
            "enabled": true,
            "state": true,
            "threshold": "80",
            "change_time": "2014-08-29T11:19:49Z",
            "severity": "WARNING",
            "change_value": {
                "state": true,
                "threshold": "80",
                "memory_util": 81.2
            }
        },
        "..."
    },
    "..."
}

Status codes {#get-all-status-codes}

Get database alerts {#get-bdbs-alerts}

GET /v1/bdbs/alerts/{int: uid}

Get all alert states for a database.

Required permissions

Request {#get-request-alerts}

Example HTTP request

GET /v1/bdbs/alerts/1 

Request headers

Response {#get-response-alerts}

Returns a hash of [alert objects]({{< relref "/operate/rs/7.22/references/rest-api/objects/alert" >}}) and their states.

Example JSON body

{
    "bdb_size": {
        "enabled": true,
        "state": true,
        "threshold": "80",
        "severity": "WARNING",
        "change_time": "2014-08-29T11:19:49Z",
        "change_value": {
            "state": true,
            "threshold": "80",
            "memory_util": 81.2
        }
    },
    "..."
}

Status codes {#get-status-codes-alerts}

Get database alert {#get-bdbs-alert}

GET /v1/bdbs/alerts/{int: uid}/{alert}

Get a database alert state.

Required permissions

Request {#get-request}

Example HTTP request

GET /v1/bdbs/alerts/1/bdb_size 

Request headers

URL parameters

Response {#get-response}

Returns an [alert object]({{< relref "/operate/rs/7.22/references/rest-api/objects/alert" >}}).

Example JSON body

{
    "enabled": true,
    "state": true,
    "threshold": "80",
    "severity": "WARNING",
    "change_time": "2014-08-29T11:19:49Z",
    "change_value": {
        "state": true,
        "threshold": "80",
        "memory_util": 81.2
    }
}

Status codes {#get-status-codes}

Update database alert {#post-bdbs-alerts}

POST /v1/bdbs/alerts/{int: uid}

Updates a database's alerts configuration.

Required permissions

Request {#post-request}

If passed with the dry_run URL query string, the function will validate the alert thresholds, but not commit them.

Example HTTP request

POST /v1/bdbs/alerts/1 

Example JSON body

{
     "bdb_size":{
         "threshold":"80",
         "enabled":true
     },
     "bdb_high_syncer_lag":{
         "threshold":"",
         "enabled":false
     },
     "bdb_low_throughput":{
         "threshold":"1",
         "enabled":true
     },
     "bdb_high_latency":{
         "threshold":"3000",
         "enabled":true
     },
     "bdb_high_throughput":{
         "threshold":"1",
         "enabled":true
     },
     "bdb_backup_delayed":{
         "threshold":"1800",
         "enabled":true
     }
}

Request headers

URL parameters

Request body

The request must contain a single JSON object with one or many database [alert objects]({{< relref "/operate/rs/7.22/references/rest-api/objects/alert" >}}).

Response {#post-response}

The response includes the updated database [alerts]({{< relref "/operate/rs/7.22/references/rest-api/objects/alert" >}}).

Status codes {#post-status-codes}