API de alertas

nota

Esta sección solo se aplica a las alertas clásicas. Para obtener más información, consulte Alertas de Grafana.

Usa la API de preferencias para obtener información sobre las alertas clásicas del panel de control y sus estados. Sin embargo, no puedes usar esta API para modificar la alerta. Para crear alertas nuevas o modificarlas, debe actualizar el JSON del panel de control que contiene las alertas.

nota

Para usar una API de Grafana con tu espacio de trabajo de Grafana gestionado por Amazon, debes tener un token de API de Grafana válido. Lo incluyes en el Authorization campo de la solicitud de API. Para obtener información sobre cómo crear un token para autenticar tus llamadas a la API, consultaAutenticación con tokens.

Recibe alertas

GET /api/alerts

Ejemplo de solicitud

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

Parámetros de la cadena de consulta:

Estos parámetros se utilizan como parámetros de cadena de consulta. Por ejemplo: /api/alerts?dashboardId=1

• DashboardID: limita las respuestas a las alertas en el valor especificado del panel de control. Puede especificar varios paneles. Por ejemplo, dashboardId=23&dashboardId=35

• PanelID: limita la respuesta a la alerta de un panel específico de un panel de control.

• consulta: limita la respuesta a las alertas que tengan un nombre como este valor.

• estado: devuelve las alertas que tienen uno o más de los siguientes estados de alerta: ALL alertingok,no_data,paused, opending. Para especificar varios estados, utilice el siguiente formato: ?state=paused&state=alerting

• límite: limita la respuesta a un número X de alertas.

• folderID: limita la respuesta a las alertas de los paneles de control de las carpetas especificadas. Puede especificar varias carpetas. Por ejemplo, folderId=23&folderId=35

• DashboardQuery: limita las respuestas a las alertas que tengan un nombre de panel como este valor.

• DashboardTag: limita las alertas de respuesta de los paneles con etiquetas específicas. Para filtrar «AND» con varias etiquetas, especifique el parámetro de etiquetas varias veces. Por ejemplo, dashboardTag=tag1&dashboardTag=tag2. Tenga en cuenta que estas son etiquetas de Grafana, no AWS etiquetas.

Ejemplo de respuesta

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"
  }
]

Recibe una alerta por ID

GET /api/alerts/:id

Ejemplo de solicitud

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

Ejemplo de respuesta

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"
}

importante

evalMatcheslos datos se almacenan en caché en la base de datos cuando y solo cuando cambia el estado de la alerta. Si los datos de un servidor activan primero la alerta y, antes de que se vea que ese servidor abandona el estado de alerta, un segundo servidor también entra en un estado que activaría la alerta, el segundo servidor no está visible en los evalMatches datos.

Pausa la alerta por ID

POST /api/alerts/:id/pause

Ejemplo de solicitud

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

{
  "paused": true
}

El parámetro de :id consulta es el identificador de la alerta que se va a pausar o dejar de pausar. pausedpuede ser true pausar una alerta o volver false a pausarla.

Ejemplo de respuesta

HTTP/1.1 200
Content-Type: application/json

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