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

downtime オブジェクト

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

downtime.getダウンタイムの取得

downtime.getは、ダウンタイムの情報を取得するためのメソッドです。

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

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

リクエストパラメータ

カラム名称 概要
type string

取得するダウンタイムの種別を指定します。

all
全てのダウンタイムスケジュールを取得します。
host
ホストのダウンタイムスケジュールを取得します。
service
サービスのダウンタイムスケジュールを取得します。

省略時には、allが指定されます。

レスポンスカラム

カラム名称 概要
host_name string

ダウンタイムが設定されているホストID

service_display_name string

ダウンタイムが設定されているサービスID

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

entry_time string

ダウンタイムを設定した日時のUNIXTIME

author string

ダウンタイムを設定したユーザID

comment string

ダウンタイム設定時のコメント文

start_time string

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

end_time string

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

fixed string

ダウンタイムの種類

0
フレキシブルスケジュール
1
固定スケジュール
duration string

フレキシブルスケジュールの期間秒数

id string

ダウンタイムID

triggered_by string

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

未指定の場合は、0になります。

downtime.addダウンタイムをスケジュール

downtime.addは、指定したホストやサービスにダウンタイムをスケジュールするためのメソッドです。

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

リクエストパラメータ

カラム名称 概要
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が指定されます。

fixed boolean

ダウンタイムの種類を指定します。

true
固定スケジュールのダウンタイムになります。
固定スケジュールの場合、指定した開始日時から終了日時までの期間をダウンタイムとみなします。
false
フレキシブルスケジュールのダウンタイムになります。
フレキシブルスケジュールの場合、指定した開始日時から終了日時までの期間に、障害が発生してからdurationで指定した分数の間をダウンタイムとみなします。

省略時には、trueが指定されます。

start_time integer

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

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

end_time integer

ダウンタイムの終了日時をUNIXTIMEで指定します。

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

duration integer

フレキシブルスケジュールの期間を分数で指定します。

省略時には120が指定され、2時間と解釈されます。

triggered_by integer

トリガーとなるdowntime_idを指定します。

レスポンスカラム

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