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

recurring_downtime オブジェクト

recurring_downtimeオブジェクトは、X-MONのダウンタイムの定期設定情報を操作するオブジェクトです。

recurring_downtime.getダウンタイムの定期設定を取得

recurring_downtime.getは、ダウンタイムの定期設定を取得するためのメソッドです。

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

リクエストパラメータ

カラム名称 型 概要
hosts array

取得する定期設定の対象ホストIDを指定します。
services array

取得する定期設定の対象サービスIDを、
ホストID : (コロン)サービスIDの形式で指定します。

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

取得する定期設定の対象ホストグループIDを指定します。
service_groups array

取得する定期設定の対象サービスグループIDを指定します。
pattern_type string

取得する定期設定の周期タイプを指定します。

week
毎週繰り返す定期設定を取得します。
month
毎月繰り返す定期設定を取得します。

省略時には、全ての定期設定を取得します。

レスポンスカラム

カラム名称 型 概要
id string

定期設定の一意なID
name string

定期設定名称
hosts array

ダウンタイム対象のホストID
services array

ダウンタイム対象のサービスID
host_groups array

ダウンタイム対象のホストグループID
service_groups array

ダウンタイム対象のサービスグループID
add_host_downtime boolean

services または service_groups を指定した場合に、
ホストのダウンタイムも合わせてスケジュールするかどうか
add_service_downtime boolean

hosts または host_groups を指定した場合に、
サービスのダウンタイムも合わせてスケジュールするかどうか
comment string

定期設定のコメント
child_hosts_action integer

hosts や host_groups または add_host_downtime を指定した場合に、
子ホストのダウンタイムも合わせてスケジュールするかどうか

0
何もしない
1
同時に子ホストにも、ダウンタイムをスケジュールする
（このダウンタイムをトリガーに設定する）
2
同時に子ホストにも、ダウンタイムをスケジュールする
（このダウンタイムをトリガーに設定しない）
pattern_type string

定期設定の周期

week
毎週繰り返す定期設定
month
毎月繰り返す定期設定
pattern string

定期設定の間隔

pattern_type 「 week 」の場合、予定する曜日をカンマ区切りで表示します。

  • mo：月曜日
  • tu：火曜日
  • we：水曜日
  • th：木曜日
  • fr：金曜日
  • sa：土曜日
  • su：日曜日

　(例：月曜日,水曜日,金曜日の場合「mo,we,fr」)

pattern_type 「 month 」の場合は以下3通りで表示します。

1~31の数字
月の指定された日
(例：毎月15日に予定された場合「15」)
数字-曜日
その月の一番初めに指定した曜日が現れた日を第一とした相対的な日
(例：毎月第二水曜日に予定された場合「2-we」)
end
月の末日
start_time string

定期設定の開始時間
end_time string

定期設定の終了時間
duration integer

開始時間から終了時間までの期間の分数
entry_time integer

定期設定の登録日時
author string

定期設定を登録したユーザID

recurring_downtime.addダウンタイムの定期設定を追加

recurring_downtime.addは、ダウンタイムの定期設定を追加するためのメソッドです。

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

リクエストパラメータ

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

定期設定名称を指定します。
hosts 必須 array

ダウンタイム対象のホストIDを指定します。

hosts, services, host_groups, service_groups のいずれかの指定が必須です。
services 必須 array

ダウンタイム対象のサービスIDを、
ホストID : (コロン)サービスIDの形式で指定します。

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

hosts, services, host_groups, service_groups のいずれかの指定が必須です。
host_groups 必須 array

ダウンタイム対象のホストグループIDを指定します。

指定することで、そのホストグループに含まれる全てのホストに
ダウンタイムがスケジュールされます。

hosts, services, host_groups, service_groups のいずれかの指定が必須です。
service_groups 必須 array

ダウンタイム対象のサービスグループIDを指定します。

指定することで、そのサービスグループに含まれる全てのサービスに
ダウンタイムがスケジュールされます。

hosts, services, host_groups, service_groups のいずれかの指定が必須です。
add_host_downtime boolean

services または service_groups を指定した場合に、
ホストのダウンタイムも合わせてスケジュールするかどうかを指定します。

省略時には、falseが指定されます。
add_service_downtime boolean

hosts または host_groups を指定した場合に、
サービスのダウンタイムも合わせてスケジュールするかどうかを指定します。

省略時には、falseが指定されます。
comment string

コメントを指定します。

省略時には、ダウンタイムを誰が設定したかの情報が記述されます。
child_hosts_action integer

hosts や host_groups または add_host_downtime を指定した場合に、
子ホストのダウンタイムも合わせてスケジュールするかどうかを指定します。

0
何もしない
1
同時に子ホストにも、ダウンタイムをスケジュールする
（このダウンタイムをトリガーに設定する）
2
同時に子ホストにも、ダウンタイムをスケジュールする
（このダウンタイムをトリガーに設定しない）

省略時には、0が指定されます。
pattern_type 必須 string

ダウンタイムの周期を指定します。

week
毎週繰り返す定期設定となります。
month
毎月繰り返す定期設定となります。
pattern 必須 string

ダウンタイムの間隔を指定します。
指定内容は pattern_type によって変わります。

pattern_type 「 week 」の場合、予定する曜日をカンマ区切りで指定します。

  • mo：月曜日
  • tu：火曜日
  • we：水曜日
  • th：木曜日
  • fr：金曜日
  • sa：土曜日
  • su：日曜日

　(例：月曜日,水曜日,金曜日に予定する場合「mo,we,fr」)

pattern_type 「 month 」の場合は以下3通りで指定します。

1~31の数字
指定された日にダウンタイム予定を登録します。
(例：毎月15日に予定する場合「15」)
数字-曜日
その月の一番初めに指定した曜日が現れた日を第一としたダウンタイム予定を登録します。
(例：毎月第二水曜日に予定する場合「2-we」)
end
月の末日にダウンタイム予定を登録します。
start_time string

ダウンタイムの開始時間を「HH:ii:ss」のフォーマットで指定します。
end_time string

ダウンタイムの終了時間を「HH:ii:ss」のフォーマットで指定します。

レスポンスカラム

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

recurring_downtime.updateダウンタイムの定期設定を編集

recurring_downtime.updateは、ダウンタイムの定期設定を編集するためのメソッドです。

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

リクエストパラメータ

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

定期設定IDを指定します。
name string

定期設定名称を指定します。
hosts array

ダウンタイム対象のホストIDを指定します。
services array

ダウンタイム対象のサービスIDを、
ホストID : (コロン)サービスIDの形式で指定します。

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

ダウンタイム対象のホストグループIDを指定します。

指定することで、そのホストグループに含まれる全てのホストに
ダウンタイムがスケジュールされます。
service_groups array

ダウンタイム対象のサービスグループIDを指定します。

指定することで、そのサービスグループに含まれる全てのサービスに
ダウンタイムがスケジュールされます。
add_host_downtime boolean

services または service_groups を指定した場合に、
ホストのダウンタイムも合わせてスケジュールするかどうかを指定します。
add_service_downtime boolean

hosts または host_groups を指定した場合に、
サービスのダウンタイムも合わせてスケジュールするかどうかを指定します。
comment string

コメントを指定します。
child_hosts_action integer

hosts や host_groups または add_host_downtime を指定した場合に、
子ホストのダウンタイムも合わせてスケジュールするかどうかを指定します。

0
何もしない
1
同時に子ホストにも、ダウンタイムをスケジュールする
（このダウンタイムをトリガーに設定する）
2
同時に子ホストにも、ダウンタイムをスケジュールする
（このダウンタイムをトリガーに設定しない）
pattern_type string

ダウンタイムの周期を指定します。

week
毎週繰り返す定期設定となります。
month
毎月繰り返す定期設定となります。
pattern string

ダウンタイムの間隔を指定します。
指定内容は pattern_type によって変わります。

pattern_type 「 week 」の場合、予定する曜日をカンマ区切りで指定します。

  • mo：月曜日
  • tu：火曜日
  • we：水曜日
  • th：木曜日
  • fr：金曜日
  • sa：土曜日
  • su：日曜日

　(例：月曜日,水曜日,金曜日に予定する場合「mo,we,fr」)

pattern_type 「 month 」の場合は以下3通りで指定します。

1~31の数字
指定された日にダウンタイム予定を登録します。
(例：毎月15日に予定する場合「15」)
数字-曜日
その月の一番初めに指定した曜日が現れた日を第一としたダウンタイム予定を登録します。
(例：毎月第二水曜日に予定する場合「2-we」)
end
月の末日にダウンタイム予定を登録します。
start_time string

ダウンタイムの開始時間を「HH:ii:ss」のフォーマットで指定します。

省略時には、コマンドを発行した時間が指定されます。
end_time string

ダウンタイムの終了時間を「HH:ii:ss」のフォーマットで指定します。

省略時には、ダウンタイムの開始時間から2時間後が指定されます。

レスポンスカラム

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

recurring_downtime.deleteダウンタイムの定期設定を削除

recurring_downtime.deleteは、ダウンタイムの定期設定を削除するためのメソッドです。

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

リクエストパラメータ

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

定期設定IDを指定します。

レスポンスカラム

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

recurring_downtime_next.get定期ダウンタイムの次回予定を取得

recurring_downtime_next.getは、定期設定から次回のダウンタイム予定を取得するためのメソッドです。

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

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

リクエストパラメータ

このメソッドにはパラメータは不要です。

レスポンスカラム

カラム名称 型 概要
host_name string

ダウンタイム対象のホストID
service_description string

ダウンタイム対象のサービスID

ホストのダウンタイムの場合は空欄になります。
comment string

定期設定のコメント
child_hosts_action integer

hosts や host_groups または add_host_downtime を指定した場合に、
子ホストのダウンタイムも合わせてスケジュールするかどうか

ホストのダウンタイムのみ表示されます。

0
何もしない
1
同時に子ホストにも、ダウンタイムをスケジュールする
（このダウンタイムをトリガーに設定する）
2
同時に子ホストにも、ダウンタイムをスケジュールする
（このダウンタイムをトリガーに設定しない）
start_time integer

ダウンタイムの開始日時のUNIXTIME
end_time integer

ダウンタイムの終了日時のUNIXTIME
fixed boolean

ダウンタイムの種類

true
固定スケジュールのダウンタイムになります。
false
フレキシブルスケジュールのダウンタイムになります。

定期設定のダウンタイムは全て固定スケジュールとなります。
duration integer

開始時間から終了時間までの期間の分数
triggered_by string

トリガーとして設定されているダウンタイムID

定期設定のダウンタイムは全て0となります。
recurring_downtime_id string

定期設定の一意なID
recurring_downtime_name string

定期設定名称
entry_time integer

定期設定の登録日時
author string

定期設定を登録したユーザID

recurring_downtime_exclude.add定期ダウンタイムの次回予定を除外

recurring_downtime_exclude.addは、定期設定の次回のダウンタイム予定から特定のホスト・サービスを指定し除外するためのメソッドです。

除外されたホスト・サービスのダウンタイムは次の予定が生成されます。

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

リクエストパラメータ

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

定期設定IDを指定します。
host_name 必須 string

除外するホストIDを指定します。
service_description string

除外するサービスIDを指定します。
サービスのダウンタイムの場合のみ必須です。
start_time 必須 integer

ダウンタイム予定の開始日時をUNIXTIMEで指定します。

レスポンスカラム

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