チェック監視

チェック監視の一覧

チェック監視の一覧を取得します。

GET /api/v0/monitoring/checks

APIキーに必要な権限

  • Read

入力（クエリパラメータ）

PARAM TYPE DESCRIPTION
nextId string [optional] 指定されたIDを持つチェック監視以降を取得する
limit number [optional] 取得するチェック監視の最大数（最大100、デフォルト100）

応答

成功時

{
  "checks": [<check>, <check>, …],
  "nextId": "abc123"
}

並び順は、チェック監視のIDの昇順です。nextId はチェック監視が limit 件より多くあるときに返されます。次のリクエストの nextId パラメータに使用します。

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

KEY TYPE DESCRIPTION
id string チェック監視のID
name string チェック監視の名前

失敗時

STATUS CODE DESCRIPTION
400 limit の値が最大値(100)より大きい場合

チェック監視の取得

チェック監視を取得します。

GET /api/v0/monitoring/checks/<monitorId>

APIキーに必要な権限

  • Read

応答

成功時

{
  "check": <check>
}

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

KEY TYPE DESCRIPTION
id string チェック監視のID
name string チェック監視の名前

失敗時

STATUS CODE DESCRIPTION
404 指定したmonitorIdのチェック監視が存在しない場合

チェック監視結果の投稿

チェック監視の結果を Mackerel に送信します。監視結果はホストに紐付きます。

POST /api/v0/monitoring/checks/report

チェック監視項目を追加する の実装に使われています。 エージェントは設定されたチェック監視の名前の一覧を ホスト情報の更新 の API に定期的に送信しており、その時に一覧に含まれず、かつ発生中のアラートのないチェック監視は Mackerel から削除されます。 以下の場合、投稿は無視されます。

  • 監視時刻が投稿時刻の6時間以上前である場合
  • 同じ名前/ホストで監視時刻が新しいものが既に投稿されていた場合

APIキーに必要な権限

  • Read
  • Write

入力

{
  "reports": [ <report>, <report>, … ]
}

<report> : 以下のキーをもつオブジェクトです。1回のAPIリクエストでは最大100件の <report> を送信できます。

KEY TYPE DESCRIPTION
source source 下記参照。
name string 監視名。
status string 監視結果のアラートステータス。"OK"、 "CRITICAL"、 "WARNING"、 "UNKNOWN" のいずれかです。
message string 監視結果のアラートステータスに付随する補助的なテキスト, 1024文字以下です。
occurredAt number 監視実行時刻のエポック秒。
notificationInterval number [optional] アラートの再送間隔 (分) 省略した場合は再送されない。10分未満を指定した場合は、10分間隔で再送通知されます。
maxCheckAttempts number [optional] 何回連続で Warning/Critical になったらアラートを発生させるか*1。デフォルトは1 (1~10)です。

source : 以下のキーをもつオブジェクトです。

KEY TYPE DESCRIPTION
type string 定数文字列 "host"
hostId string ホストID（ホスト登録時にサーバから与えられるもの）

応答

成功時

{
  "success": true
}

失敗時

STATUS CODE DESCRIPTION
403 APIキーに書き込み権限がないとき / 許可されたIPアドレス範囲外からのアクセスの場合
200以外 上記以外のエラー

*1 maxCheckAttempts

maxCheckAttempts が2以上である場合、正常に動作するためにはチェック監視の投稿間隔が6時間以内である必要があります。