hostescalations オブジェクト

hostescalationsオブジェクトは、X-MONのホストエスカレーション設定を操作するオブジェクトです。

hostescalationsオブジェクトは、X-MON3.9.0より廃止されました。

3.9.0以降のバージョンをご利用の場合、escalationオブジェクトでエスカレーション設定を操作してください。

メソッド一覧
- hostescalations.get
- hostescalations.update

hostescalations.getホストエスカレーション設定の取得

hostescalations.getは、ホストエスカレーション設定を取得するためのメソッドです。

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

リクエストパラメータ

カラム名称	型	概要
host_name 必須	string	ホストIDを指定します。

レスポンスカラム

カラム名称	型	概要
host_name	string	ホストID
notification_interval	integer	エスカレーション間隔
escalations	array	対象ホストのエスカレーション設定 enabled エスカレーションの有効/無効 true 有効 false 無効 first_notification 実行開始回数 notification_count 実行回数実行回数を制限していない場合は空白が返されます。 type 実行内容 contactgroup ユーザグループへのメール通知 contact ユーザへのメール通知 trap TRAP送信のコマンド実行 signaltower 警告灯点灯のコマンド実行 command エスカレーションコマンド実行 twilio Twilio API連携のコマンド実行 target メールの通知先または実行するコマンド typeカラムの値がtrapの場合は空白が返されます。 options_down ステータスDOWN時にエスカレーションを有効にするかどうか true 有効にする false 無効にする options_unreachable ステータスUNREACHABLE時にエスカレーションを有効にするかどうか true 有効にする false 無効にする options_recovery ステータス復旧時にエスカレーションを有効にするかどうか true 有効にする false 無効にする

hostescalations.updateホストエスカレーション設定の更新

hostescalations.updateは、ホストエスカレーション設定を編集するためのメソッドです。

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

オペレータ権限の場合、approveカラムを明示的にfalseとする必要があります。

リクエストパラメータ

カラム名称	型	概要
host_name 必須	string	ホストIDを指定します。
notification_interval	integer	エスカレーション間隔を指定します。省略時には、対象ホストの監視間隔の値が指定され、監視間隔が0の場合は5が指定されます。
escalations 必須	array	対象ホストのエスカレーションを指定します。 enabled エスカレーションの有効/無効を指定します。 true 有効 false 無効 first_notification 必須実行開始回数を指定します。 notification_count 実行回数を指定します。実行回数を制限しない場合、空白にしてください。 type 必須実行内容を指定します。 contactgroup ユーザグループへのメール通知 contact ユーザへのメール通知 trap TRAP送信のコマンド実行 signaltower 警告灯点灯のコマンド実行 command エスカレーションコマンド実行 twilio Twilio API連携のコマンド実行 target メールの通知先または実行するコマンドを指定します。 typeカラムでtrapを指定している場合は、空白にしてください。 trap以外を指定している場合は値の入力が必須となります。 options_down ステータスDOWN時にエスカレーションを有効にするかどうかを指定します。省略時には、falseが指定されます。 options_down, options_unreachable, options_recoveryの1つ以上がtrueである必要があります。 true 有効にする false 無効にする options_unreachable ステータスUNREACHABLE時にエスカレーションを有効にするかどうかを指定します。省略時には、falseが指定されます。 options_down, options_unreachable, options_recoveryの1つ以上がtrueである必要があります。 true 有効にする false 無効にする options_recovery ステータス復旧時にエスカレーションを有効にするかどうかを指定します。省略時には、falseが指定されます。 options_down, options_unreachable, options_recoveryの1つ以上がtrueである必要があります。 true 有効にする false 無効にする
approve	boolean	このリクエストを即座に反映するかどうかを指定します。省略時には、trueの指定となり、即座に反映されます。

レスポンスカラム

このメソッドは、実行結果が boolean型で返ってきます。