2016-03-22

アラート

アラートの一覧
アラートの取得
アラートの更新
アラートを閉じる
アラートログの取得

アラートの一覧

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

GET /api/v0/alerts

APIキーに必要な権限

Read

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

次のパラメータでアラートを絞り込むことができます。withClosedが指定されていない場合は、発生中のアラートのみが返却されます。 nextIdが指定されていない場合は、直近のアラートの発生時刻の新しい順で返却されます。

PARAM	TYPE	DESCRIPTION
`withClosed`	boolean	[optional] 解決済みのアラートも取得するかどうか。真なら発生済みに加えて解決済みのアラートも取得されます。
`nextId`	string	[optional] `nextId` が指定された場合は、指定されたアラートのidよりも以前のアラートを取得します。
`limit`	number	[optional] 取得するアラートの上限数。省略時は100件まで取得します。指定できる最大は100です。

応答

成功時

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

並び順は、アラートの発生時刻が新しい順です。 nextId はアラートが limit 件より多くあるときに取得されます。

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

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

*1 series

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

KEY	TYPE	DESCRIPTION
`name`	string	監視対象のラベル対応メトリックの名前。例: "container.cpu.utilization"
`labels`	object	監視対象のラベル対応メトリックのラベル一覧。ラベルのキーと値をキーと値とするオブジェクト。例: `{"ip":"127.0.0.1"}`

失敗時

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

アラートの取得

GET /api/v0/alerts/<alertId>

APIキーに必要な権限

Read

応答

成功時

アラートの情報が返却されます。形式はアラートの一覧で取得できるアラートの形式と同様です。

失敗時

STATUS CODE	DESCRIPTION
404	指定されたIDのアラートがみつからないとき

アラートの更新

PUT /api/v0/alerts/<alertId>

APIキーに必要な権限

Read
Write

入力

{
  "memo": "<text>"
}

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

応答

成功時

アラートのIDとメモが返却されます。

  "id": "<alertId>",
  "memo": "<text>"

失敗時

STATUS CODE	DESCRIPTION
403	APIキーに書き込み権限がないとき / 許可されたIPアドレス範囲外からのアクセスの場合
404	指定されたIDのアラートがみつからないとき
413	指定されたメモが80KBを超過している時

アラートを閉じる

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

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

APIキーに必要な権限

Read
Write

入力

{
  "reason": "<text>"
}

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

応答

成功時

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

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

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

失敗時

STATUS CODE	DESCRIPTION
404	`<alertId>` に対応するアラートが見つからないとき
403	APIキーに書き込み権限がないとき / 許可されたIPアドレス範囲外からのアクセスの場合

アラートログの取得

アラートログを取得します。

GET /api/v0/alerts/<alertId>/logs

APIキーに必要な権限

Read

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

nextIdが指定されていない場合は、直近のアラートの発生時刻の新しい順で返却されます。

PARAM	TYPE	DESCRIPTION
`nextId`	string	[optional] `nextId` が指定された場合は、指定されたアラートログのidよりも以前のアラートを取得します。
`limit`	number	[optional] 取得するアラートログの上限数。省略時は100件まで取得します。指定できる最大は100です。

応答

成功時

{
  "logs": [<log>, <log>, ...],
  "nextId": xxx
}

並び順は、アラートの発生時刻が新しい順です。 nextId はアラートが limit 件より多くあるときに取得されます。

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

KEY	TYPE	DESCRIPTION
`id`	string	アラートログのid。
`status`	string	ログ発生時点でのアラートのステータス。 `"OK"`、 `"CRITICAL"`、 `"WARNING"`、 `"UNKNOWN"` のいずれかになります。
`trigger`	string	ログが作成された理由の種別。監視ルール (`"monitoring"`)、手動 (`"manual"`)、監視ルールの削除 (`"monitorDelete"`)、ホストの退役 (`"hostRetire"`)、サービスの削除 (`"serviceDelete"`)、ロール内異常検知の手動による再学習 (`"anomalyDetectionManuallyRetraining"`)、外形監視に紐付くサービスの変更 (`"externalMonitoringServiceChange"`) のいずれかになります。
`monitorId`	string / null	ログを作成した監視ルールのID。リクエスト時点で監視ルールが変更または削除されていると`null`になります。
`targetValue`	number / null	アラートログ発生時点での計測値。メトリック監視以外は`null`になります。
`statusDetail`	object / null	監視対象の状態の詳細。チェック監視の場合にのみ存在します。 *1
`createdAt`	number	ログの作成日時(epoch秒)。

*1 statusDetail

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

KEY	TYPE	DESCRIPTION
`type`	string	監視ルールの種別。常に`check`になります。
`detail`	object	状態の詳細情報。*2

*2 detail

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

KEY	TYPE	DESCRIPTION
`message`	string	Mackerelに投稿されたチェック監視の結果。
`memo`	string	監視ルールのメモ。

失敗時

STATUS CODE	DESCRIPTION
400	`limit` の値が最大値（100）より大きい場合
404	指定されたIDのアラートがみつからないとき