timeperiodオブジェクトは、X-MONの時刻設定を操作するオブジェクトです。
timeperiod.addは、時刻設定を新規作成するためのメソッドです。
| 対応X-MONバージョン |
|
|---|---|
| 必要ユーザ権限 |
|
オペレータ権限の場合、approveカラムを明示的にfalseとする必要があります。
| カラム名称 | 型 | 概要 |
|---|---|---|
| timeperiod_name 必須 | string |
時刻IDを指定します。 |
| alias | string |
時刻の名称を指定します。 省略時には、timeperiod_nameと同じ値が指定されます。 |
| exclude | array |
除外時刻として設定する除外時刻設定の時刻IDを指定します。 |
| sunday | string |
日曜日の監視時間帯を指定します。 00:00-24:00 といったフォーマットで指定してください。 |
| monday | string |
月曜日の監視時間帯を指定します。 00:00-24:00 といったフォーマットで指定してください。 |
| tuesday | string |
火曜日の監視時間帯を指定します。 00:00-24:00 といったフォーマットで指定してください。 |
| wednesday | string |
水曜日の監視時間帯を指定します。 00:00-24:00 といったフォーマットで指定してください。 |
| thursday | string |
木曜日の監視時間帯を指定します。 00:00-24:00 といったフォーマットで指定してください。 |
| friday | string |
金曜日の監視時間帯を指定します。 00:00-24:00 といったフォーマットで指定してください。 |
| saturday | string |
土曜日の監視時間帯を指定します。 00:00-24:00 といったフォーマットで指定してください。 |
| approve | boolean |
このリクエストを即座に反映するかどうかを指定します。 省略時には、trueの指定となり、即座に反映されます。 |
このメソッドは、実行結果が boolean型で返ってきます。
timeperiod.deleteは、時刻設定を削除するためのメソッドです。
| 対応X-MONバージョン |
|
|---|---|
| 必要ユーザ権限 |
|
オペレータ権限の場合、approveカラムを明示的にfalseとする必要があります。
| カラム名称 | 型 | 概要 |
|---|---|---|
| timeperiod_name 必須 | string |
時刻IDを指定します。 |
| approve | boolean |
このリクエストを即座に反映するかどうかを指定します。 省略時には、trueの指定となり、即座に反映されます。 |
このメソッドは、実行結果が boolean型で返ってきます。
timeperiod.getは、時刻設定を取得するためのメソッドです。
| 対応X-MONバージョン |
|
|---|---|
| 必要ユーザ権限 |
|
| カラム名称 | 型 | 概要 |
|---|---|---|
| timeperiod_name | string | 取得する時刻を指定します。 |
| key | string |
検索する時刻設定を指定します。 空欄を指定した場合、全ての時刻設定を取得します。 |
| limit | integer |
検索時に取得する件数を指定します。 省略時は、全件が取得されます。 |
| offset | integer |
取得開始する時刻設定の行数を指定します。 省略時は、0が指定されます。 |
このメソッドは、timeperiod_nameもしくはkeyのどちらかの指定が必要です。
| カラム名称 | 型 | 概要 |
|---|---|---|
| id | string |
内部管理用のID |
| timeperiod_name | string |
時刻ID |
| alias | string |
時刻の名称 |
| sunday | string |
日曜日の監視時間帯 |
| monday | string |
月曜日の監視時間帯 |
| tuesday | string |
火曜日の監視時間帯 |
| wednesday | string |
水曜日の監視時間帯 |
| thursday | string |
木曜日の監視時間帯 |
| friday | string |
金曜日の監視時間帯 |
| saturday | string |
土曜日の監視時間帯 |
| exclude | array |
除外時刻として設定された除外時刻設定の時刻ID |
timeperiod.updateは、既存の時刻設定を編集するためのメソッドです。
| 対応X-MONバージョン |
|
|---|---|
| 必要ユーザ権限 |
|
オペレータ権限の場合、approveカラムを明示的にfalseとする必要があります。
| カラム名称 | 型 | 概要 |
|---|---|---|
| timeperiod_name 必須 | string |
時刻IDを指定します。 |
| alias | string |
時刻の名称を指定します。 |
| exclude | array |
除外時刻として設定する除外時刻設定の時刻IDを指定します。 |
| sunday | string |
日曜日の監視時間帯を指定します。 00:00-24:00 といったフォーマットで指定してください。 |
| monday | string |
月曜日の監視時間帯を指定します。 00:00-24:00 といったフォーマットで指定してください。 |
| tuesday | string |
火曜日の監視時間帯を指定します。 00:00-24:00 といったフォーマットで指定してください。 |
| wednesday | string |
水曜日の監視時間帯を指定します。 00:00-24:00 といったフォーマットで指定してください。 |
| thursday | string |
木曜日の監視時間帯を指定します。 00:00-24:00 といったフォーマットで指定してください。 |
| friday | string |
金曜日の監視時間帯を指定します。 00:00-24:00 といったフォーマットで指定してください。 |
| saturday | string |
土曜日の監視時間帯を指定します。 00:00-24:00 といったフォーマットで指定してください。 |
| approve | boolean |
このリクエストを即座に反映するかどうかを指定します。 省略時には、trueの指定となり、即座に反映されます。 |
このメソッドは、実行結果が boolean型で返ってきます。