1. index
  2. 監視
  3. 設定
  4. コマンド
  5. その他

escalation オブジェクト

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

escalation.getエスカレーション設定の取得

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

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

リクエストパラメータ

カラム名称 型 概要
escalation_id string

エスカレーションIDを指定します。

エスカレーションIDを指定した場合、残りの引数に関わらず、指定したIDを持つエスカレーション設定が1件のみ取得できます。
alias string

エスカレーション名称を指定します。
type string

取得するエスカレーション種別を指定します。

all
すべての種別のエスカレーションを取得する
host
ホストエスカレーションを取得する
service
サービスエスカレーションを取得する
base_type string

取得するエスカレーションの設定方法を指定します。

all
すべての設定方法のエスカレーションを取得する
time
時間指定のエスカレーションを取得する
count
回数指定のエスカレーションを取得する
limit integer

検索時に取得する件数を指定します。

省略時は、全件が取得されます。
offset string

取得するエスカレーション設定の開始行数を指定します。

省略時は、0が指定されます。
targets array

取得するエスカレーション設定のエスカレーション対象を配列で指定します。

配列内は以下のキー名を持つ連想配列で指定します。

target_type

エスカレーション対象の種別を指定します。

all
すべてのホスト・サービス
host
ホスト
service
サービス
hostgroup
ホストグループ
servicegroup
サービスグループ
target

エスカレーション対象のIDを指定します。

IDの指定方法はtarget_typeの指定内容によって変わります。

target_type 「all」 を指定した場合
空文字列を指定します。
target_type 「host」 を指定した場合
ホストIDを指定します。
target_type 「service」 を指定した場合

ホストIDとサービスIDを : (コロン)で接続した文字列を指定します。

(例：ホスト「X-MON」のサービス「PING」を指定する場合「X-MON:PING」)

target_type 「hostgroup」 を指定した場合
ホストグループIDを指定します。
target_type 「servicegroup」 を指定した場合
サービスグループIDを指定します。
filter_type string

targetに指定されたエスカレーション対象の検索方法を指定します。

strict

厳格な検索

target に指定されたホスト・サービス・ホストグループ・サービスグループをエスカレーション対象に持つエスカレーションのみを検索します。

parent

親要素を含んだ検索

target に指定されたホスト・サービスを含むホスト・ホストグループ・サービスグループをエスカレーション対象に持つエスカレーションも検索します。

child

子要素を含んだ検索

target に指定されたホスト・ホストグループ・サービスグループに含まれるホスト・サービスをエスカレーション対象に持つエスカレーションも検索します。

レスポンスカラム

以下のカラムをキー名に持つ連想配列を含んだ配列が返ります。

カラム名称 型 概要
escalation_id string

エスカレーションID
alias string

エスカレーション名称
type string

エスカレーション種別を取得します。

host
ホストエスカレーション
service
サービスエスカレーション
base_type string

エスカレーションの設定方法を取得します。

time
時間指定のエスカレーション
count
回数指定のエスカレーション
delay integer

回数指定のエスカレーションの場合、初回通知の遅延時間を取得します。

時刻指定のエスカレーションの場合、「0」を取得します。
period string

時刻IDを取得します。
targets array

エスカレーション対象を配列で取得します。

配列内は以下のキー名を持つ連想配列が含まれます。

target_type

エスカレーション対象の種別を取得します。

all
すべてのホスト・サービス
host
ホスト
service
サービス
hostgroup
ホストグループ
servicegroup
サービスグループ
target

エスカレーション対象のIDを取得します。

IDの取得内容はtarget_typeによって変わります。

target_type「all」の場合
空文字列を取得します。
target_type「host」の場合
ホストIDを取得します。
target_type「service」の場合

ホストIDとサービスIDを : (コロン)で接続した文字列を取得します。

(例：ホスト「X-MON」のサービス「PING」を取得した場合「X-MON:PING」)

target_type「hostgroup」の場合
ホストグループIDを取得します。
target_type「servicegroup」の場合
サービスグループIDを取得します。
panels array

エスカレーション条件を配列で取得します。

配列内は以下のキー名を持つ連想配列が含まれます。

panel_id

エスカレーション条件ID

status

エスカレーションステータス

problem

ホストエスカレーション： DOWN と UNREACHABLE で通知

サービスエスカレーション： CRITICAL と WARNING、UNKNOWN で通知

down
ホストDOWN時に通知
unreachable
ホストUNREACHABLE時に通知
up
ホストUP時に通知
over_warning
サービスのCRITICAL と WARNING 時に通知
critical
サービスCRITICAL時に通知
warning
サービスWARNING時に通知
unknown
サービスUNKNOWN時に通知
ok
サービスOK時に通知
notification
ダウンタイム と 認知済み、フラッピング検知 時に通知
acknowledge
認知済み時に通知
downtime
ダウンタイム時に通知
flapping
フラッピング検知時に通知
enabled

エスカレーション条件が有効かどうか

true
有効
false
無効
delay

回数指定のエスカレーションの場合、初回通知の遅延時間を取得します。

時刻指定のエスカレーションの場合、初回遅延時間を取得します。

retry_time

回数指定のエスカレーションの場合、エスカレーション間隔を取得します。

時刻指定のエスカレーションの場合、障害継続時の再通知間隔を取得します。

retry_count

回数指定のエスカレーションの場合、再通知回数を取得します。

時刻指定のエスカレーションの場合、「0(再通知回数無制限)」を取得します。

notify_status_change

ステータス変化時の通知を有効にするかどうか

true
有効
false
無効
notify_recovery

復旧時の通知を有効にするか

true
有効
false
無効
commands

条件にマッチした際のエスカレーション実行内容を配列で取得します。

配列内は以下のキー名を持つ連想配列が含まれます。

command_type

コマンドの種別を取得します。

contacts
メール - ユーザ通知
contactgroup
メール - ユーザグループ通知
trap
TRAP送信
signaltower
警告灯点灯
command
コマンド実行
twilio
Twilio - ボタン操作付き通話
twilio_simple
Twilio - シンプル通話
twilio_sms
Twilio - SMS通知
target

コマンドのIDを取得します。

IDの取得内容は command_type によって変わります。

command_type 「 contacts 」の場合
ユーザIDを 取得 します。
command_type 「 contactgroup 」の場合
ユーザグループIDを 取得 します。
command_type 「 trap 」の場合
空文字列を 取得 します。
command_type 「 signaltower 」の場合
警告灯通知IDを 取得 します。
command_type 「 command 」の場合
コマンドIDを 取得 します。
command_type 「 twilio 」の場合
Twilio通知IDを 取得 します。
command_type 「 twilio_simple 」の場合
Twilio通知設定(シンプル通話) IDを 取得 します。
command_type 「 twilio_sms 」の場合
Twilio SMS通知設定 IDを 取得 します。

実行例

すべてのエスカレーション設定を取得する

リクエスト
{ "jsonrpc": "2.0", "id": "1", "user_id": "admin", "auth_token": "0b7670bda71ac0a38e384ab7d4956d19e13655e5", "method": "escalation.get", "params": [] }
レスポンス
{ "jsonrpc": "2.0", "result": [ { "escalation_id": "d700e5cd-b0e6-4154-aed8-ab36c73742f0", "alias": "sample escalation", "type": "host", "base_type": "time", "delay": 0, "period": "24x7", "targets": [ { "target_type": "host", "target": "X-MON" } ], "panels": [ { "panel_id": "db17a166-c8fa-4a4a-aefc-e0120d1489cd", "status": "problem", "enabled": true, "delay": 0, "retry_time": 120, "retry_count": 0, "notify_status_change": true, "notify_recovery": true, "commands": [ { "command_type": "contact", "target": "admin" } ] } ] }, // ... match escalation setting ], "id": "1" }

ホストグループ「HOSTGROUP_A」に含まれるホスト・サービスをエスカレーション対象に持つエスカレーション設定の一覧を取得する

リクエスト
{ "jsonrpc": "2.0", "id": "1", "user_id": "admin", "auth_token": "0b7670bda71ac0a38e384ab7d4956d19e13655e5", "method": "escalation.get", "params": { "targets": [ { "target_type": "hostgroup", "target": "HOSTGROUP_A" } ], "filter_type": "child" } }
レスポンス
{ "jsonrpc": "2.0", "result": [ // ... return match escalation setting ], "id": "1" }

escalation.addエスカレーション設定の追加

escalation.add は、エスカレーション設定を追加するためのメソッドです。

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

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

リクエストパラメータ

カラム名称 型 概要
alias 必須 string

エスカレーション名称 を 指定 します。
type 必須 string

エスカレーション種別 を 指定 します。

host
ホストエスカレーション
service
サービスエスカレーション
base_type 必須 string

エスカレーションの設定方法を 指定 します。

time
時間指定のエスカレーション
count
回数指定のエスカレーション
delay integer

回数指定のエスカレーションの場合、初回通知の遅延時間を 指定 します。

時刻指定のエスカレーションの場合、指定内容にかかわらず「0」が 指定 されます。

指定しない場合0が 指定 されます。
period string

通知時間帯を 時刻ID で 指定 します。

指定しない場合 「24x7」 が 指定 されます。
targets array

エスカレーション対象を配列で 指定 します。

配列内は以下のキー名を持つ連想配列を 指定 します。

target_type (string)

エスカレーション対象の種別を 指定 します。

all
すべてのホスト・サービス
host
ホスト
service
サービス
hostgroup
ホストグループ
servicegroup
サービスグループ
target (string)

エスカレーション対象のIDを 指定 します。

IDの取得内容はtarget_typeによって変わります。

target_type「all」の場合
空文字列を 指定 します。
target_type「host」の場合
ホストIDを 指定 します。
target_type「service」の場合

ホストIDとサービスIDを : (コロン)で接続した文字列を 指定 します。

(例：ホスト「X-MON」のサービス「PING」を取得した場合「X-MON:PING」)

target_type「hostgroup」の場合
ホストグループIDを 指定 します。
target_type「servicegroup」の場合
サービスグループIDを 指定 します。
panels 必須 array

エスカレーション条件を配列で 指定 します。

配列内は以下のキー名を持つ連想配列を少なくとも1件 指定 します。

status (string) 必須

エスカレーションステータス を 指定 します。

problem

ホストエスカレーション： DOWN と UNREACHABLE で通知

サービスエスカレーション： CRITICAL と WARNING、UNKNOWN で通知

down
ホストDOWN時に通知
unreachable
ホストUNREACHABLE時に通知
up
ホストUP時に通知
over_warning
サービスのCRITICAL と WARNING 時に通知
critical
サービスCRITICAL時に通知
warning
サービスWARNING時に通知
unknown
サービスUNKNOWN時に通知
ok
サービスOK時に通知
notification
ダウンタイム と 認知済み、フラッピング検知 時に通知
acknowledge
認知済み時に通知
downtime
ダウンタイム時に通知
flapping
フラッピング検知時に通知
enabled (boolean)

エスカレーション条件が有効かどうか

true
有効
false
無効

指定しない場合 「true」 が 指定 されます。

delay (integer)

回数指定のエスカレーションの場合、初回通知の遅延時間を 指定 します。

時刻指定のエスカレーションの場合、初回遅延時間を 指定 します。

指定しない場合 「0」 が 指定 されます。

「status」カラムで通知遅延が発生しないもの(ok, up, notification, downtime, flapping, acknowledge)を選択した場合

指定内容によらず 「0」 が 指定 されます。

retry_time (integer)

回数指定のエスカレーションの場合、エスカレーション間隔を 指定 します。

時刻指定のエスカレーションの場合、障害継続時の再通知間隔を 指定 します。

指定しない場合 「120」 が 指定 されます。

retry_count (integer)

回数指定のエスカレーションの場合、再通知回数を 指定 します。

時刻指定のエスカレーションの場合、指定内容によらず「0(再通知回数無制限)」が 指定 されます。

指定しない場合 「0」 が 指定 されます。

「status」カラムで再通知しないもの(ok, up, notification, downtime, flapping, acknowledge)を選択した場合

指定内容によらず 「0」 が 指定 されます。

notify_status_change (boolean)

ステータス変化時の通知を有効にするかどうか

true
有効
false
無効

指定しない場合 「true」 が 指定 されます。

回数指定のエスカレーションや、「status」カラムでステータス変化しないもの(ok, up, notification, downtime, flapping, acknowledge)を選択した場合

「false」 が 指定 されます。

notify_recovery (boolean)

復旧時の通知を有効にするか

true
有効
false
無効

指定しない場合 「true」 が 指定 されます。

「status」カラムで復旧しないもの(ok, up, notification, downtime, flapping, acknowledge)を選択した場合

「false」 が 指定 されます。

commands (array) 必須

条件にマッチした際のエスカレーション実行内容を配列で 指定 します。

配列内は以下のキー名を持つ連想配列を含みます。

command_type (string)

コマンドの種別を 指定 します。

contacts
メール - ユーザ通知
contactgroup
メール - ユーザグループ通知
trap
TRAP送信
signaltower
警告灯点灯
command
コマンド実行
twilio
Twilio - ボタン操作付き通話
twilio_simple
Twilio - シンプル通話
twilio_sms
Twilio - SMS通知
target (string)

コマンドのIDを 指定 します。

IDの取得内容は command_type によって変わります。

command_type 「 contacts 」の場合
ユーザIDを 指定 します。
command_type 「 contactgroup 」の場合
ユーザグループIDを 指定 します。
command_type 「 trap 」の場合
空文字列を 取得 します。
command_type 「 signaltower 」の場合
警告灯通知IDを 指定 します。
command_type 「 command 」の場合
コマンドIDを 指定 します。
command_type 「 twilio 」の場合
Twilio通知IDを 指定 します。
command_type 「 twilio_simple 」の場合
Twilio通知設定(シンプル通話) IDを 指定 します。
command_type 「 twilio_sms 」の場合
Twilio SMS通知設定 IDを 指定 します。
approve boolean

このリクエストを即座に反映するかどうかを指定します。

true
即座に反映する
false
承認待ちに登録する

指定しない場合 「true」 が 指定 されます。

レスポンスカラム

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

実行例

時刻ベースのエスカレーション設定を追加する

リクエスト
{ "jsonrpc": "2.0", "id": "1", "user_id": "admin", "auth_token": "0b7670bda71ac0a38e384ab7d4956d19e13655e5", "method": "escalation.add", "params": { "alias": "sample time base escalation", "type": "service", "base_type": "time", "delay": 0, "period": "24x7", "targets": [ { "target_type": "host", "target": "X-MON" } ], "panels": [ { "status": "notification", "enabled": true, "delay": 0, "retry_time": 0, "retry_count": 0, "notify_status_change": false, "notify_recovery": false, "commands": [ { "command_type": "contacts", "target": "admin" } ] }, { "status": "problem", "enabled": true, "delay": 0, "retry_time": 120, "retry_count": 0, "notify_status_change": true, "notify_recovery": true, "commands": [ { "command_type": "contacts", "target": "admin" } ] } ], "approve": true } }
レスポンス
{ "jsonrpc": "2.0", "result": true, "id": "1" }

回数ベースのエスカレーション設定を登録する

リクエスト
{ "jsonrpc": "2.0", "id": "1", "user_id": "admin", "auth_token": "0b7670bda71ac0a38e384ab7d4956d19e13655e5", "method": "escalation.add", "params": { "alias": "sample time base escalation", "type": "service", "base_type": "count", "delay": 5, "period": "24x7", "targets": [ { "target_type": "host", "target": "X-MON" } ], "panels": [ { "status": "notification", "enabled": true, "delay": 0, "retry_time": 0, "retry_count": 0, "notify_status_change": false, "notify_recovery": false, "commands": [ { "command_type": "contacts", "target": "admin" } ] }, { "status": "problem", "enabled": true, "delay": 0, "retry_time": 120, "retry_count": 0, "notify_status_change": true, "notify_recovery": true, "commands": [ { "command_type": "contacts", "target": "operator" } ] }, { "status": "problem", "enabled": true, "delay": 2, "retry_time": 120, "retry_count": 0, "notify_status_change": true, "notify_recovery": true, "commands": [ { "command_type": "contacts", "target": "admin" } ] } ], "approve": true } }
レスポンス
{ "jsonrpc": "2.0", "result": true, "id": "1" }

escalation.editエスカレーション設定の編集

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

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

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

リクエストパラメータ

カラム名称 型 概要
escalation_id 必須 string

エスカレーションID を 指定 します。
alias string

エスカレーション名称 を 指定 します。
base_type string

エスカレーションの設定方法を 指定 します。

time
時間指定のエスカレーション
count
回数指定のエスカレーション
delay integer

回数指定のエスカレーションの場合、初回通知の遅延時間を 指定 します。

時刻指定のエスカレーションの場合、指定内容にかかわらず「0」が 指定 されます。

指定しない場合0が 指定 されます。
period string

通知時間帯を 時刻ID で 指定 します。

指定しない場合 「24x7」 が 指定 されます。
targets array

エスカレーション対象を配列で 指定 します。

配列内は以下のキー名を持つ連想配列を 指定 します。

target_type (string)

エスカレーション対象の種別を 指定 します。

all
すべてのホスト・サービス
host
ホスト
service
サービス
hostgroup
ホストグループ
servicegroup
サービスグループ
target (string)

エスカレーション対象のIDを 指定 します。

IDの取得内容はtarget_typeによって変わります。

target_type「all」の場合
空文字列を 指定 します。
target_type「host」の場合
ホストIDを 指定 します。
target_type「service」の場合

ホストIDとサービスIDを : (コロン)で接続した文字列を 指定 します。

(例：ホスト「X-MON」のサービス「PING」を取得した場合「X-MON:PING」)

target_type「hostgroup」の場合
ホストグループIDを 指定 します。
target_type「servicegroup」の場合
サービスグループIDを 指定 します。
panels array

エスカレーション条件を配列で 指定 します。

配列内は以下のキー名を持つ連想配列を少なくとも1件 指定 します。

panel_id (string)

エスカレーション条件IDを指定します

status (string)

エスカレーションステータス を 指定 します。

problem

ホストエスカレーション： DOWN と UNREACHABLE で通知

サービスエスカレーション： CRITICAL と WARNING、UNKNOWN で通知

down
ホストDOWN時に通知
unreachable
ホストUNREACHABLE時に通知
up
ホストUP時に通知
over_warning
サービスのCRITICAL と WARNING 時に通知
critical
サービスCRITICAL時に通知
warning
サービスWARNING時に通知
unknown
サービスUNKNOWN時に通知
ok
サービスOK時に通知
notification
ダウンタイム と 認知済み、フラッピング検知 時に通知
acknowledge
認知済み時に通知
downtime
ダウンタイム時に通知
flapping
フラッピング検知時に通知
enabled (boolean)

エスカレーション条件が有効かどうか

true
有効
false
無効

指定しない場合 「true」 が 指定 されます。

delay (integer)

回数指定のエスカレーションの場合、初回通知の遅延時間を 指定 します。

時刻指定のエスカレーションの場合、初回遅延時間を 指定 します。

指定しない場合 「0」 が 指定 されます。

「status」カラムで通知遅延が発生しないもの(ok, up, notification, downtime, flapping, acknowledge)を選択した場合

指定内容によらず 「0」 が 指定 されます。

retry_time (integer)

回数指定のエスカレーションの場合、エスカレーション間隔を 指定 します。

時刻指定のエスカレーションの場合、障害継続時の再通知間隔を 指定 します。

指定しない場合 「120」 が 指定 されます。

retry_count (integer)

回数指定のエスカレーションの場合、再通知回数を 指定 します。

時刻指定のエスカレーションの場合、指定内容によらず「0(再通知回数無制限)」が 指定 されます。

指定しない場合 「0」 が 指定 されます。

「status」カラムで再通知しないもの(ok, up, notification, downtime, flapping, acknowledge)を選択した場合

指定内容によらず 「0」 が 指定 されます。

notify_status_change (boolean)

ステータス変化時の通知を有効にするかどうか

true
有効
false
無効

指定しない場合 「true」 が 指定 されます。

回数指定のエスカレーションや、「status」カラムでステータス変化しないもの(ok, up, notification, downtime, flapping, acknowledge)を選択した場合

「false」 が 指定 されます。

notify_recovery (boolean)

復旧時の通知を有効にするか

true
有効
false
無効

指定しない場合 「true」 が 指定 されます。

「status」カラムで復旧しないもの(ok, up, notification, downtime, flapping, acknowledge)を選択した場合

「false」 が 指定 されます。

commands (array)

条件にマッチした際のエスカレーション実行内容を配列で 指定 します。

配列内は以下のキー名を持つ連想配列を含みます。

command_type (string)

コマンドの種別を 指定 します。

contacts
メール - ユーザ通知
contactgroup
メール - ユーザグループ通知
trap
TRAP送信
signaltower
警告灯点灯
command
コマンド実行
twilio
Twilio - ボタン操作付き通話
twilio_simple
Twilio - シンプル通話
twilio_sms
Twilio - SMS通知
target (string)

コマンドのIDを 指定 します。

IDの取得内容は command_type によって変わります。

command_type 「 contacts 」の場合
ユーザIDを 指定 します。
command_type 「 contactgroup 」の場合
ユーザグループIDを 指定 します。
command_type 「 trap 」の場合
空文字列を 取得 します。
command_type 「 signaltower 」の場合
警告灯通知IDを 指定 します。
command_type 「 command 」の場合
コマンドIDを 指定 します。
command_type 「 twilio 」の場合
Twilio通知IDを 指定 します。
command_type 「 twilio_simple 」の場合
Twilio通知設定(シンプル通話) IDを 指定 します。
command_type 「 twilio_sms 」の場合
Twilio SMS通知設定 IDを 指定 します。
approve boolean

このリクエストを即座に反映するかどうかを指定します。

true
即座に反映する
false
承認待ちに登録する

指定しない場合 「true」 が 指定 されます。

レスポンスカラム

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

escalation.deleteエスカレーション設定の削除

escalation.delete は、エスカレーション設定を削除するためのメソッドです。

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

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

リクエストパラメータ

カラム名称 型 概要
escalation_id 必須 string

エスカレーションID を 指定 します。
approve boolean

このリクエストを即座に反映するかどうかを指定します。

true
即座に反映する
false
承認待ちに登録する

指定しない場合 「true」 が 指定 されます。

レスポンスカラム

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