アラート API - Amazon Managed Grafana
アラートの取得ID でアラートを受け取るID によるアラートの一時停止

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

アラート API

注記

このセクションは、従来のアラートにのみ適用されます。詳細については、「Grafana アラート」を参照してください。

Preferences API を使用して、従来のダッシュボードアラートとその状態に関する情報を取得します。ただし、この API を使用してアラートを変更することはできません。新しいアラートを作成または変更するには、アラートを含むダッシュボード JSON を更新する必要があります。

注記

Amazon Managed Grafana ワークスペースで 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

  • dashboardId — 指定されたダッシュボード値のアラートに応答を制限します。複数のダッシュボードを指定できます。例えば、次のようになります: dashboardId=23&dashboardId=35

  • panelId — ダッシュボード上の指定されたパネルのアラートに応答を制限します。

  • query — レスポンスを、この値のような名前のアラートに制限します。

  • state — 、、ALL、、、または のアラート状態が 1 alerting okつ以上あるアラートを返しますno_datapausedpending。複数の状態を指定するには、次の形式を使用します。 ?state=paused&state=alerting

  • limit — レスポンスを X 個のアラート数に制限します。

  • folderId — 指定されたフォルダ内のダッシュボードのアラートに応答を制限します。複数のフォルダを指定できます。例えば、次のようになります: folderId=23&folderId=35

  • dashboardQuery — この値のようなダッシュボード名を持つアラートに応答を制限します。

  • dashboardTag — 指定したタグを持つダッシュボードのレスポンスアラートを制限します。複数のタグで「AND」フィルタリングを実行するには、tags パラメータを複数回指定します。例えば 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 データは、アラートの状態が変更された場合にのみデータベースにキャッシュされます。あるサーバーのデータが最初にアラートをトリガーし、そのサーバーがアラート状態を離れるのを見る前に、2 番目のサーバーもアラートをトリガーする状態に入ると、2 番目のサーバーは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"
}