API de alertas

nota

Esta seção se aplica somente aos alertas clássicos. Para ter mais informações, consulte Alerta Grafana.

Use a API de preferências para obter informações sobre alertas clássicos do painel e seus estados. No entanto, você não pode usar essa API para modificar o alerta. Para criar novos alertas ou modificá-los, você precisa atualizar o JSON do painel que contém os alertas.

nota

Para usar uma API do Grafana com seu espaço de trabalho do Amazon Managed Grafana, você deve ter um token válido da API Grafana. Você inclui isso no Authorization campo na solicitação da API. Para obter informações sobre como criar um token para autenticar suas chamadas de API, consulteAutenticação com tokens.

Receba alertas

GET /api/alerts

Exemplo de solicitação

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

Parâmetros da sequência de caracteres de consulta:

Esses parâmetros são usados como parâmetros de sequência de caracteres de consulta. Por exemplo: /api/alerts?dashboardId=1

• DashboardID — Limite as respostas aos alertas no valor especificado dos painéis. Você pode especificar vários painéis. Por exemplo, dashboardId=23&dashboardId=35.

• PanelID — Limite a resposta ao alerta para um painel específico em um painel.

• consulta — Limite a resposta aos alertas com um nome como esse valor.

• estado — Retorna os alertas que têm um ou mais dos seguintes estados de alerta: ALLalerting,ok,,no_data,paused, oupending. Para especificar vários estados, use o seguinte formato: ?state=paused&state=alerting

• limite — Limite a resposta ao número X de alertas.

• FolderID — Limite a resposta aos alertas dos painéis nas pastas especificadas. Você pode especificar várias pastas. Por exemplo, folderId=23&folderId=35.

• DashboardQuery — Limite as respostas aos alertas com um nome de painel como esse valor.

• DashboardTag — Limite os alertas de resposta dos painéis com tags especificadas. Para fazer a filtragem “AND” com várias tags, especifique o parâmetro tags várias vezes. Por exemplo, dashboardTag=tag1&dashboardTag=tag2. Observe que essas são tags Grafana, não AWS tags.

Exemplo de resposta

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

Receba alerta por ID

GET /api/alerts/:id

Exemplo de solicitação

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

Exemplo de resposta

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

evalMatchesos dados são armazenados em cache no banco de dados quando e somente quando o estado do alerta muda. Se os dados de um servidor acionarem o alerta primeiro e, antes que esse servidor seja visto saindo do estado de alerta, um segundo servidor também entrar em um estado que acionaria o alerta, o segundo servidor não estará visível nos dados. evalMatches

Pausar alerta por ID

POST /api/alerts/:id/pause

Exemplo de solicitação

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

{
  "paused": true
}

O parâmetro de :id consulta é o ID do alerta a ser pausado ou não pausado. pausedpode ser true pausar um alerta ou false retomá-lo.

Exemplo de resposta

HTTP/1.1 200
Content-Type: application/json

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