アラート履歴用の REST API¶
重要
REST API は、Control Center を 標準モード で実行する場合にのみ利用できます。
Alerts REST API ページにアクセスするには、以下の手順に従います。
- トップバナーにあるアラートベルのアイコンをクリックします。Alerts ページが開き、デフォルトで History タブが表示されます。
- REST API タブをクリックします。
REST API ページには、アラートの履歴情報をプログラムで取得するために使用できるアラート REST エンドポイントの詳細が記載されています。
アラート履歴が入力され始めると、Sample Response が表示されます。
![入力された Alerts GET REST API 履歴ページ](../../_images/c3-alerts-rest-api-pop.png)
入力された Alerts GET REST API 履歴ページ¶
詳細については、「REST API の例」を参照してください。
REST API の例¶
-
GET
/2.0/alerts/history
¶ 最新のアラートを取得します。
クエリのパラメーター: - limit (int) -- 返す最大レコード数
- ts (long) -- 返す最新のアラート(エポックからのミリ秒単位)
レスポンスの JSON オブジェクト: - guid (string) -- このアラート固有の ID
応答(オブジェクトの JSON 配列): - timestamp (string) -- このアラートが発行されたエポックからのミリ秒単位の経過時間
- monitoringTrigger (map) -- このアラートが発行される原因になったトリガー定義
- monitoringTrigger.guid (string) -- このトリガー固有の ID
- monitoringTrigger.name (string) -- このトリガーの名前
- triggers (array) -- monitoringTrigger と関連付けられたトリガー原因
- triggers[i].window (string) -- このトリガーが発行される原因となった基礎のデータと関連付けられたエポックからのミリ秒単位の経過時間
- actions (array) -- monitoringTrigger の起動によって実行されたアクション
- actions[i].guid (string) -- 実行されたアクション固有の ID
- actions[i].name (string) -- 実行されたアクションの名前
- actions[i].email (map) -- アラートの送信先のメールアドレス
リクエストの例 :
GET /2.0/alerts/history HTTP/1.1 Accept: application/json
応答の例:
HTTP/1.1 200 OK Content-Type: application/json [ { "guid": "50c0e74a-6368-43bf-bff7-fa51beff9ad9", "timestamp": "1516207447488", "monitoringTrigger": { "guid": "c8d72271-9f57-44b5-a6a4-97c97f0d1668", "name": "rock-cg-0 consumption" }, "triggers": [ { "window": "1516207320000", "hasError": false, "component": { "componentId": "rock-cg-0" }, "longValue": "0" } ], "actions": [ { "guid": "f593d79d-1bb7-4179-8997-6a7c8045dd8e", "name": "1212", "email": { "address": "sdfsdf@lskdjf.com", "subject": "skldfjlsdkfj" } } ] } ]