status オブジェクト

statusオブジェクトは、X-MONのサービス監視結果を操作するオブジェクトです。

サービス監視設定に関する操作を知りたい方は、servicesを参照してください。

メソッド一覧
- status.get

status.getサービス監視結果の取得

status.getは、サービス監視の結果を取得するためのメソッドです。

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

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

リクエストパラメータ

カラム名称	型	概要
key	string	指定した値をホストID、ホスト名称、IPアドレスの中から部分一致で検索を行います。
host_name	string	指定した値をホストIDの部分一致で検索を行います。
host_alias	string	指定した値をホスト名称の部分一致で検索を行います。
host_address	string	指定した値をIPアドレスの部分一致で検索を行います。
hoststatustypes	array	配列に指定したステータスのホストのみを取得します。取得したいステータスを大文字で指定してください。省略時には、全てのステータスを取得します。
servicestatustypes	array	配列に指定したステータスのサービスのみを取得します。取得したいステータスを大文字で指定してください。省略時には、全てのステータスを取得します。
sort	object	取得したい結果のソート方法指定します。 sorttype ソートの順序を指定します。 asc 結果を昇順で取得します。 desc 結果を降順で取得します。省略時は、ascが指定されます。 sortoption ソートを行うカラムを指定します。 host_name ホストIDでソートを行います。 description サービスIDでソートを行います。 last_check 最終チェックが行われた日時でソートを行います。 last_state_change 最後にステータスが変更された日時でソートを行います。 state ステータスの種類でソートを行います。省略時は、host_nameが指定されます。
hostprops	object	ホストプロパティを指定します。 host_state_type_soft ソフトステートの指定 true ソフトステートの監視結果を対象にします。 host_state_type_hard ハードステートの指定 true ハードステートの監視結果を対象にします。 host_check_type_active アクティブチェック結果の指定 true アクティブチェックの監視結果を対象にします。 host_check_type_passive パッシブチェック結果の指定 true パッシブチェックの監視結果を対象にします。 host_accept_passive_checks パッシブチェック設定の指定 true パッシブチェックの設定が有効なものを対象にします。 false パッシブチェックの設定が無効なものを対象にします。省略時にはどちらも対象となります。 host_notifications_enabled 通知設定の指定 true 通知設定が有効なものを対象にします。 false 通知設定が無効なものを対象にします。省略時にはどちらも対象となります。 host_is_flapping フラップ検知の指定 true フラップ検知が行われたものを対象にします。 false フラップ検知が行われていないものを対象にします。省略時にはどちらも対象となります。 host_flap_detection_enabled フラップ検知設定の指定 true フラップ検知の設定が有効なものを対象にします。 false フラップ検知の設定が無効なものを対象にします。省略時にはどちらも対象となります。 host_event_handler_enabled イベントハンドラの指定 true イベントハンドラの設定が有効なものを対象にします。 false イベントハンドラの設定が無効なものを対象にします。省略時にはどちらも対象となります。 host_active_checks_enabled アクティブチェック設定の指定 true アクティブチェックの設定が有効なものを対象にします。 false アクティブチェックの設定が無効なものを対象にします。省略時にはどちらも対象となります。 host_acknowledged 認知済み状態の指定 true 認知済みが指定されたものを対象にします。 false 認知済みが指定されていないものを対象にします。省略時にはどちらも対象となります。 host_scheduled_downtime_depth ダウンタイム状態の指定 true ダウンタイムが指定されたものを対象にします。 false ダウンタイムが指定されていないものを対象にします。省略時にはどちらも対象となります。
serviceprops	object	サービスプロパティを指定します。 state_type_soft ソフトステートの指定 true ソフトステートの監視結果を対象にします。 state_type_hard ハードステートの指定 true ハードステートの監視結果を対象にします。 check_type_active アクティブチェック結果の指定 true アクティブチェックの監視結果を対象にします。 check_type_passive パッシブチェック結果の指定 true パッシブチェックの監視結果を対象にします。 accept_passive_checks パッシブチェック設定の指定 true パッシブチェックの設定が有効なものを対象にします。 false パッシブチェックの設定が無効なものを対象にします。省略時にはどちらも対象となります。 notifications_enabled 通知設定の指定 true 通知設定が有効なものを対象にします。 false 通知設定が無効なものを対象にします。省略時にはどちらも対象となります。 is_flapping フラップ検知の指定 true フラップ検知が行われたものを対象にします。 false フラップ検知が行われていないものを対象にします。省略時にはどちらも対象となります。 flap_detection_enabled フラップ検知設定の指定 true フラップ検知の設定が有効なものを対象にします。 false フラップ検知の設定が無効なものを対象にします。省略時にはどちらも対象となります。 event_handler_enabled イベントハンドラの指定 true イベントハンドラの設定が有効なものを対象にします。 false イベントハンドラの設定が無効なものを対象にします。省略時にはどちらも対象となります。 active_checks_enabled アクティブチェック設定の指定 true アクティブチェックの設定が有効なものを対象にします。 false アクティブチェックの設定が無効なものを対象にします。省略時にはどちらも対象となります。 acknowledged 認知済み状態の指定 true 認知済みが指定されたものを対象にします。 false 認知済みが指定されていないものを対象にします。省略時にはどちらも対象となります。 scheduled_downtime_depth ダウンタイム状態の指定 true ダウンタイムが指定されたものを対象にします。 false ダウンタイムが指定されていないものを対象にします。省略時にはどちらも対象となります。
pattern	string	プリセット設定を指定します。 problem 未処理のサービス障害のみを取得します。ホストステータス UP PENDING サービスステータス CRITICAL WARNING UNKNOWN サービスプロパティ認知済みが指定されていないものダウンタイムが指定されていないもの host_problem 3.5.0 以降未処理のホスト障害のみを取得します。ホストステータス DOWN UNREACHABLE ホストプロパティ認知済みが指定されていないものダウンタイムが指定されていないもの tac 3.5.0 以降ホストとサービスの各ステータス状態数を取得します。
servicegroup	string	指定したサービスグループに所属しているサービスの監視結果のみを取得します。
hostgroup	string	指定したホストグループに所属しているホストの監視結果のみを取得します。
host	string	指定したホストの監視結果のみを取得します。

レスポンスカラム

カラム名称	型	概要
host_name	string	ホスト名
host_alias	string	エイリアス
host_state	string	ホストステータス 0 ステータスがUP、またはPENDING 1 ステータスがDOWN 2 ステータスがUNREACHABLE PENDINGの判定は、host_has_been_checkedの値で行います。
host_address	string	ホストアドレス
host_groups	string	該当ホストが所属しているホストグループ複数に所属している場合、「,」区切りで連結されます。
groups	string	該当サービスが所属しているサービスグループ複数に所属している場合、「,」区切りで連結されます。
host_acknowledged	string	ホストの認知済みの有無 0 認知済み状態ではない 1 認知済み状態
host_notifications_enabled	string	ホストの通知の有効無効 0 通知が無効 1 通知が有効
host_active_checks_enabled	string	ホストのアクティブチェックの有効無効 0 アクティブチェックが無効 1 アクティブチェックが有効
host_is_flapping	string	ホストがフラッピングがどうか 0 フラッピングではない 1 フラッピング検知
host_scheduled_downtime_depth	string	ホストのダウンタイムスケジュールの有無 0 ダウンタイム中ではない 0以外ダウンタイム中
host_has_been_checked	string	ホストがチェック済かどうか 0 ホストチェック未実施 1 ホストチェック実施済
host_icon_image	string	ホストのアイコン画像のファイル名
description	string	サービス名
state	string	サービスステータス 0 ステータスがOK、またはPENDING 1 ステータスがWARNING 2 ステータスがCRITICAL 3 ステータスがUNKNOWN PENDINGの判定は、has_been_checkedの値で行います。
acknowledged	string	サービスの認知済みの有無 0 認知済み状態ではない 1 認知済み状態
notifications_enabled	string	サービスの通知の有効無効 0 通知が無効 1 通知が有効
active_checks_enabled	string	サービスのアクティブチェックの有効無効 0 アクティブチェックが無効 1 アクティブチェックが有効
is_flapping	string	サービスがフラッピングがどうか 0 フラッピングではない 1 フラッピング検知
scheduled_downtime_depth	string	サービスのダウンタイムスケジュールの有無 0 ダウンタイム中ではない 0以外ダウンタイム中
has_been_checked	string	サービスがチェック済かどうか 0 サービスチェック未実施 1 サービスチェック実施済
last_check	string	サービスの最終確認日時のUNIXTIME
last_state_change	string	サービスの最終ステータス変更日時のUNIXTIME
current_attempt	string	現在の試行回数
max_check_attempts	string	最大試行回数
next_check	string	次回スケジュール日時のUNIXTIME
plugin_output	string	ステータス情報

実行例

サービスの監視結果を全て取得する

リクエスト

{ 　"jsonrpc":"2.0", 　"method":"status.get", 　"id":"1", 　"user_id":"admin", 　"auth_token":"0b7670bda71ac0a38e384ab7d4956d19e13655e5" }

未認知の障害発生サービスを取得する

リクエスト（プリセットを使った場合）

{ 　"jsonrpc":"2.0", 　"method":"status.get", 　"params":{ 　　"pattern":"problem" 　}, 　"id":"1", 　"user_id":"admin", 　"auth_token":"0b7670bda71ac0a38e384ab7d4956d19e13655e5" }

リクエスト（プリセットを使わない場合）

{ 　"jsonrpc":"2.0", 　"method":"status.get", 　"params":{ 　　"hoststatustypes":["UP","PENDING"], 　　"servicestatustypes":["CRITICAL","WARNING","UNKNOWN"], 　　"serviceprops":{ 　　　"acknowledged":false, 　　　"scheduled_downtime_depth":false, 　　} 　}, 　"id":"1", 　"user_id":"admin", 　"auth_token":"0b7670bda71ac0a38e384ab7d4956d19e13655e5" }