알림 API

참고

이 섹션은 클래식 알림에만 적용됩니다. 자세한 정보는 Grafana 알림을 참조하세요.

기본 설정 API를 사용하여 클래식 대시보드 알림과 해당 상태에 대한 정보를 얻을 수 있습니다. 하지만 이 API를 사용하여 알림을 수정할 수는 없습니다. 새 알림을 만들거나 수정하려면 알림이 포함된 대시보드 JSON을 업데이트해야 합니다.

참고

아마존 관리형 그라파나 워크스페이스에서 Grafana API를 사용하려면 유효한 Grafana API 토큰이 있어야 합니다. API 요청의 필드에 이를 포함시키세요. Authorization API 호출을 인증하기 위한 토큰을 생성하는 방법에 대한 자세한 내용은 을 참조하십시오토큰으로 인증.

알림 받기

GET /api/alerts

요청 예제

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

쿼리 문자열 매개변수:

이 파라미터는 쿼리 문자열 파라미터로 사용됩니다. 예: /api/alerts?dashboardId=1

• 대시보드 ID — 알림에 대한 응답을 지정된 대시보드 값으로 제한합니다. 대시보드를 여러 개 지정할 수 있습니다. 예제: dashboardId=23&dashboardId=35

• PanelID — 대시보드의 지정된 패널에 대한 경고 응답을 제한합니다.

• query — 이 값과 같은 이름을 가진 알림에 대한 응답을 제한합니다.

• 상태 -ALL,, alerting ok no_datapaused, 또는 경고 상태 중 하나 이상의 경고를 반환합니다pending. 여러 상태를 지정하려면 다음 형식을 사용합니다. ?state=paused&state=alerting

• 제한 - 응답을 X개의 알림으로 제한합니다.

• FolderID - 지정된 폴더에 있는 대시보드의 알림에 대한 응답을 제한합니다. 폴더를 여러 개 지정할 수 있습니다. 예제: folderId=23&folderId=35

• DashboardQuery - 대시보드 이름이 이 값과 같은 알림에 대한 응답을 제한합니다.

• DashboardTag — 지정된 태그가 있는 대시보드의 응답 알림을 제한합니다. 여러 태그를 사용하여 “AND” 필터링을 수행하려면 태그 매개변수를 여러 번 지정하십시오. 예를 들어 dashboardTag=tag1&dashboardTag=tag2입니다. 참고로 이들은 태그가 아니라 Grafana 태그입니다. AWS

응답의 예

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

ID로 알림 받기

GET /api/alerts/:id

요청 예제

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

응답의 예

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

중요

evalMatches알림 상태가 변경될 때만 데이터가 데이터베이스에 캐시됩니다. 한 서버의 데이터가 경고를 먼저 트리거하고 해당 서버가 경고 상태를 벗어나는 것이 보이기 전에 다른 서버도 경고를 트리거할 수 있는 상태로 전환되면 데이터에 두 번째 서버가 표시되지 않습니다. evalMatches

ID를 기준으로 알림 일시 중지

POST /api/alerts/:id/pause

요청 예제

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

{
  "paused": true
}

:id쿼리 매개변수는 일시 중지하거나 일시 중지 해제할 알림의 ID입니다. paused알림을 일시 중지하거나 알림 일시 중지를 true false 해제할 수 있습니다.

응답의 예

HTTP/1.1 200
Content-Type: application/json

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