Alarm-API

Anmerkung

Dieser Abschnitt bezieht sich nur auf klassische Benachrichtigungen. Weitere Informationen finden Sie unter Grafana-Warnung.

Verwenden Sie die Einstellungen-API, um Informationen zu klassischen Dashboard-Benachrichtigungen und deren Status abzurufen. Sie können diese API jedoch nicht verwenden, um die Warnung zu ändern. Um neue Benachrichtigungen zu erstellen oder zu ändern, müssen Sie die Dashboard-JSON aktualisieren, die die Benachrichtigungen enthält.

Anmerkung

Um eine Grafana-API mit Ihrem Amazon Managed Grafana-Workspace verwenden zu können, benötigen Sie ein gültiges Grafana-API-Token. Sie fügen dies in das Authorization Feld in der API-Anfrage ein. Informationen zum Erstellen eines Tokens zur Authentifizierung Ihrer API-Aufrufe finden Sie unterAuthentifizieren Sie sich mit Tokens.

Erhalten Sie Benachrichtigungen

GET /api/alerts

Beispielanforderung

GET /api/alerts HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Querystring-Parameter:

Diese Parameter werden als Querystring-Parameter verwendet. Beispiel: /api/alerts?dashboardId=1

• dashboardID — Beschränkt die Antworten auf Alerts im angegebenen Dashboard-Wert. Sie können mehrere Dashboards angeben. Beispiel: dashboardId=23&dashboardId=35

• PanelID — Beschränkt die Reaktion auf eine Warnung für ein bestimmtes Panel in einem Dashboard.

• query — Beschränkt die Antwort auf Alerts mit einem Namen wie diesem Wert.

• state — Gibt die Alerts zurück, die einen oder mehrere der folgenden Warnungsstatus haben: ALL alertingok,,no_data,paused, oderpending. Verwenden Sie das folgende Format, um mehrere Status anzugeben: ?state=paused&state=alerting

• Limit — Beschränkt die Antwort auf die X-Anzahl von Alarmen.

• folderId — Beschränkt die Reaktion auf Benachrichtigungen von Dashboards in den angegebenen Ordnern. Sie können mehrere Ordner angeben. Beispiel: folderId=23&folderId=35

• dashboardQuery — Beschränken Sie die Antworten auf Benachrichtigungen mit einem Dashboard-Namen wie diesem Wert.

• dashboardTag — Beschränkt die Antwortwarnungen von Dashboards mit bestimmten Tags. Um die „UND“ -Filterung mit mehreren Tags durchzuführen, geben Sie den Tags-Parameter mehrmals an. z. B. dashboardTag=tag1&dashboardTag=tag2. Beachten Sie, dass dies Grafana-Tags sind, keine AWS Tags.

Beispielantwort

HTTP/1.1 200
Content-Type: application/json

[
  {
    "id": 1,
    "dashboardId": 1,
    "dashboardUId": "ABcdEFghij"
    "dashboardSlug": "sensors",
    "panelId": 1,
    "name": "fire place sensor",
    "state": "alerting",
    "newStateDate": "2018-05-14T05:55:20+02:00",
    "evalDate": "0001-01-01T00:00:00Z",
    "evalData": null,
    "executionError": "",
    "url": "http://grafana.com/dashboard/db/sensors"
  }
]

Lassen Sie sich per ID benachrichtigen

GET /api/alerts/:id

Beispielanforderung

GET /api/alerts/1 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

Beispielantwort

HTTP/1.1 200
Content-Type: application/json

{
  "id": 1,
  "dashboardId": 1,
  "dashboardUId": "ABcdEFghij"
  "dashboardSlug": "sensors",
  "panelId": 1,
  "name": "fire place sensor",
  "state": "alerting",
  "message": "Someone is trying to break in through the fire place",
  "newStateDate": "2018-05-14T05:55:20+02:00",
  "evalDate": "0001-01-01T00:00:00Z",
  "evalData": "evalMatches": [
    {
      "metric": "movement",
      "tags": {
        "name": "fireplace_chimney"
      },
      "value": 98.765
    }
  ],
  "executionError": "",
  "url": "http://grafana.com/dashboard/db/sensors"
}

Wichtig

evalMatchesDaten werden in der Datenbank zwischengespeichert, wann und nur wenn sich der Status der Warnung ändert. Wenn Daten von einem Server zuerst die Warnung auslösen und, bevor dieser Server den Warnstatus verlässt, auch ein zweiter Server in einen Zustand übergeht, der die Warnung auslösen würde, ist der zweite Server in den evalMatches Daten nicht sichtbar.

Warnung nach ID pausieren

POST /api/alerts/:id/pause

Beispielanforderung

POST /api/alerts/1/pause HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

{
  "paused": true
}

Der :id Abfrageparameter ist die ID der Warnung, die angehalten oder aufgehoben werden soll. pausedkann das Anhalten einer Warnung oder true false das Aufheben der Pause der Warnung sein.

Beispielantwort

HTTP/1.1 200
Content-Type: application/json

{
  "alertId": 1,
  "state":   "Paused",
  "message": "alert paused"
}