読者です 読者をやめる 読者になる 読者になる

アラート

アラートの取得

openなアラートの一覧を取得します。

GET /api/v0/alerts

APIキーに必要な権限

  • Read

応答

{
  "alerts": [<alert>, <alert>, ...]
}

並び順は、アラートの発生時刻が新しい順です。

<alert> は以下のキーを持つオブジェクトです。

KEY TYPE DESCRIPTION
id string アラートのid。
status string アラートの現在のステータス "OK""CRITICAL""WARNING""UNKNOWN" のいずれかになります。
monitorId string アラートを発生させた監視設定のid。
type string 監視設定の種別。疎通 ("connectivity")、ホストメトリック ("host")、サービスメトリック ("service")、外形監視 ("external")、チェック監視 ("check")、式監視 ("expression") のいずれかになります。
hostId string [optional] 関連するホストのid。監視設定の種別が "connectivity""host""check"の時のみ存在します。
value number [optional] 監視対象の値。監視設定の種別が "host""service" の時または "external"で応答時間の設定があるときのみ存在します。
message string [optional] 監視対象のメッセージ。監視設定の種別が "check" の時または "external" の時のみ存在します。
reason string [optional] アラートを閉じた時に投稿されたreasonが返される。アラートが解決していない時は存在しません。
openedAt number アラートの発生時刻 (epoch秒)
closedAt number [optional] アラートの解決時刻 (epoch秒)。アラートが既に解決している時のみ存在します。

アラートを閉じる

指定したアラートを閉じます。

POST /api/v0/alerts/<alertId>/close

APIキーに必要な権限

  • Read
  • Write

入力

{
  "reason": <text>
}

reason フィールドには任意のテキストを記述できます。このフィールドは必須項目です。

応答

成功時

更新後のアラートを返します。

{
  "id": "<alertId>",
  "status": "OK",
  ...
  "reason": <reason>,
  "opendAt": <opendAt>,
  "closedAt": <closedAt>
}

アラートの取得の項目の <alert> オブジェクトと同じです。 reasonclosedAt が存在します。

失敗時

STATUS CODE DESCRIPTION
404 <alertId> に対応するアラートが見つからないとき
403 必要な権限がないとき