notifications オブジェクト

notificationsオブジェクトは、X-MONの通知履歴を操作するオブジェクトです。

メソッド一覧
- notifications.get

notifications.get通知履歴の取得

notifications.getは、通知履歴を取得するためのメソッドです。

対応X-MONバージョン	3.0.9 以降
必要ユーザ権限	システム管理者運用責任者オペレータ閲覧者通知ユーザ

閲覧者権限のユーザは、閲覧対象ホストグループが設定されている場合、閲覧対象として許可されている通知履歴のみが取得されます。

リクエストパラメータ

カラム名称	型	概要
start_time	integer	通知履歴の取得開始日時をUNIXTIMEで指定します。省略時には、リクエスト発行日の00:00:00が指定されます。
end_time	integer	通知履歴の取得終了日時をUNIXTIMEで指定します。省略時には、リクエスト発行日の23:59:59が指定されます。
viewtype	string	通知履歴の種別を指定します。 all 全ての通知履歴 command コマンドの通知履歴 mail メールの通知履歴省略時には、allが指定されます。
host_name	string	指定したホストIDで絞り込みを行います。 host_name, hostgroup_name, servicegroup_name は複数指定することはできません。いずれか一つのみ指定できます。
hostgroup_name	string	指定したホストグループIDで絞り込みを行います。 host_name, hostgroup_name, servicegroup_name は複数指定することはできません。いずれか一つのみ指定できます。
servicegroup_name	string	指定したサービスグループIDで絞り込みを行います。 host_name, hostgroup_name, servicegroup_name は複数指定することはできません。いずれか一つのみ指定できます。
service_description	string	指定したサービスIDで絞り込みを行います。
information_key	string	指定した文字列でステータス情報の部分一致検索を行います。
warning	boolean	ステータスWARNINGの通知履歴を取得 true 取得する false 取得しない省略時は、trueが指定されます。
unknown	boolean	ステータスUNKNOWNの通知履歴を取得 true 取得する false 取得しない省略時は、trueが指定されます。
critical	boolean	ステータスCRITICALの通知履歴を取得 true 取得する false 取得しない省略時は、trueが指定されます。
ok	boolean	ステータスOKの通知履歴を取得 true 取得する false 取得しない省略時は、trueが指定されます。
down	boolean	ステータスDOWNの通知履歴を取得 true 取得する false 取得しない省略時は、trueが指定されます。
unreachable	boolean	ステータスUNREACHABLEの通知履歴を取得 true 取得する false 取得しない省略時は、trueが指定されます。
up	boolean	ステータスUPの通知履歴を取得 true 取得する false 取得しない省略時は、trueが指定されます。
host_flapping	boolean	ホストのフラップ通知を取得 true 取得する false 取得しない省略時は、trueが指定されます。
service_flapping	boolean	サービスのフラップ通知を取得 true 取得する false 取得しない省略時は、trueが指定されます。
host_acknowledgement	boolean	ホストの認知済み通知を取得 true 取得する false 取得しない省略時は、trueが指定されます。
service_acknowledgement	boolean	サービスの認知済み通知を取得 true 取得する false 取得しない省略時は、trueが指定されます。
host_downtime 3.10.0 以降	boolean	ホストのダウンタイム通知を取得 true 取得する false 取得しない省略時は、trueが指定されます。
service_downtime 3.10.0 以降	boolean	サービスのダウンタイム通知を取得 true 取得する false 取得しない省略時は、trueが指定されます。
host_now	boolean	ホストの今すぐ通知を取得 true 取得する false 取得しない省略時は、trueが指定されます。
service_now	boolean	サービスの今すぐ通知を取得 true 取得する false 取得しない省略時は、trueが指定されます。
sorttype	string	ソートの順序を指定します。 asc 結果を昇順で取得します。 desc 結果を降順で取得します。省略時は、ascが指定されます。
limit	integer	取得する通知履歴の数を指定します。省略時は、50が指定されます。
offset	integer	取得開始する通知履歴の行数を指定します。省略時は、0が指定されます。

レスポンスカラム

カラム名称	型	概要
host	string	ホストID
service	string	サービスID
type	integer	通知の種類 0 ホストの停止状態(DOWN) 1 ホストの未到達状態(UNREACHABLE) 2 ホストの復旧状態(RECOVERY) 3 HOST CUSTOM 4 ホストの障害認知状態(ACKNOWLEDGEMENT) 5 ホストのフラッピング開始 6 ホストのフラッピング停止 7 異常状態(CRITICAL) 8 警告状態(WARNING) 9 正常状態(RECOVERY) 10 SERVICE CUSTOM 11 障害認知状態(ACKNOWLEDGEMENT) 12 フラッピング開始 13 フラッピング停止 14 不明(UNKNOWN) 15 ホストのダウンタイム開始 16 ホストのダウンタイム停止 17 ホストのダウンタイムキャンセル 18 ダウンタイム開始 19 ダウンタイム停止 20 ダウンタイムキャンセル
time	string	通知の日時
contact	string	通知先ユーザID
notification_command	string	通知の実行コマンド
information	string	通知されたステータス情報