FutureNet

NXR,WXRシリーズ

REST-API編

8. 各種サービス設定

8-7. スケジュール設定(scheduler)

 処理概要

スケジュール設定に関する処理を実行します。

 

URIおよびメソッド

機能 Version URI メソッド
POST PUT GET DELETE
Schedule v2 /api/v2/scheduler
/api/v2/scheduler/sched-list
/api/v2/scheduler/sched-list/{NUM}

凡例:〇対応、-未対応

  • api/v1は対応していません。

 

実行例

スケジュール設定の作成

メソッド URI
POST /api/v2/scheduler/sched-list
JSON
リクエスト

POST /api/v2/scheduler/sched-list
Content-Type: application/json

 

{
"sched-list": {
"number": 1,
"time": {
"minute": 0,
"hour": 1
},
"date": {
"day": "*",
"month": "*"
},
"order": {
"type": "system",
"action": "restart"
}
}
}

 

レスポンス

201 Created

 

XML
リクエスト

POST /api/v2/scheduler/sched-list
Content-Type: application/xml

 

<scheduler>
<sched-list>
<number>1</number>
<time>
<minute>0</minute>
<hour>1</hour>
</time>
<date>
<day>*</day>
<month>*</month>
</date>
<order>
<type>system</type>
<action>restart</action>
</order>
</sched-list>
</scheduler>

 

レスポンス

201 Created

 

全スケジュール設定の取得

メソッド URI
GET /api/v2/scheduler/sched-list
JSON
リクエスト

GET /api/v2/scheduler/sched-list
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"sched-list": [
{
"number": 1,
"time": {
"minute": 0,
"hour": 1
},
"date": {
"day": "*",
"month": "*"
},
"order": {
"type": "system",
"action": "restart"
}
},
{
"number": 2,
"time": {
"minute": 0,
"hour": 4
},
"date": {
"day": "*",
"month": "*"
},
"order": {
"type": "syslog",
"action": "rotate"
}
}
]
}

 

XML
リクエスト

GET /api/v2/scheduler/sched-list
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<scheduler>
<sched-list>
<number>1</number>
<time>
<minute>0</minute>
<hour>1</hour>
</time>
<date>
<day>*</day>
<month>*</month>
</date>
<order>
<type>system</type>
<action>restart</action>
</order>
</sched-list>
<sched-list>
<number>2</number>
<time>
<minute>0</minute>
<hour>4</hour>
</time>
<date>
<day>*</day>
<month>*</month>
</date>
<order>
<type>syslog</type>
<action>rotate</action>
</order>
</sched-list>
</scheduler>

 

TEXT/PLAIN
リクエスト

GET /api/v2/scheduler/sched-list
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

schedule 1 01:00 * * system restart
schedule 2 04:00 * * syslog rotate

 

スケジュール設定の更新

メソッド URI
PUT /api/v2/scheduler/sched-list/{NUM}
JSON
リクエスト

PUT /api/v2/scheduler/sched-list/1
Content-Type: application/json

 

{
"number": 1,
"time": {
"minute": 0,
"hour": 5
},
"date": {
"day": "*",
"month": "*"
},
"order": {
"type": "system",
"action": "restart"
}
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/scheduler/sched-list/1
Content-Type: application/xml

 

<sched-list>
<number>1</number>
<time>
<minute>0</minute>
<hour>5</hour>
</time>
<date>
<day>*</day>
<month>*</month>
</date>
<order>
<type>system</type>
<action>restart</action>
</order>
</sched-list>

 

レスポンス

204 No content

 

スケジュール設定の取得

メソッド URI
GET /api/v2/scheduler/sched-list/{NUM}
JSON
リクエスト

GET /api/v2/scheduler/sched-list/1
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"number": 1,
"time": {
"minute": 0,
"hour": 5
},
"date": {
"day": "*",
"month": "*"
},
"order": {
"type": "system",
"action": "restart"
}
}

 

XML
リクエスト

GET /api/v2/scheduler/sched-list/1
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<sched-list>
<number>1</number>
<time>
<minute>0</minute>
<hour>5</hour>
</time>
<date>
<day>*</day>
<month>*</month>
</date>
<order>
<type>system</type>
<action>restart</action>
</order>
</sched-list>

 

TEXT/PLAIN
リクエスト

GET /api/v2/scheduler/sched-list/1
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

schedule 1 05:00 * * system restart

 

スケジュール設定の削除

メソッド URI
DELETE /api/v2/scheduler/sched-list/{NUM}
リクエスト

DELETE /api/v2/scheduler/sched-list/1

 

レスポンス

204 No content

 

パラメータ

指定可能なパラメータは下記の通りです。

なお指定可能なパラメータは、製品およびファームウェアのバージョンにより異なりますので、各パラメータの詳細については、各製品のユーザーズガイド(CLI版)も合わせてご参照ください。

  • パラメータ表の説明文中の記号について
    < > … 括弧内の値の範囲から選択することを示しています。
    [ ] … 括弧内の値のどれかを選択することを示しています。
  • パラメータ表の説明文中のデータタイプについて
    A.B.C.D … IPv4アドレス
    A.B.C.D/M … IPv4プレフィックスおよびマスク長
    X:X::X:X … IPv6アドレス
    X:X::X:X/M … IPv6プレフィックスおよびプレフィックス長

 

パラメータおよびレベル 説明
Lv.1 Lv.2 Lv.3 Lv.4 Lv.5
scheduler sched-list number スケジュール番号
time minute 分 … <0-59>
hour 時 … <0-23>、毎時の場合は*
date day 日 … <1-31>、毎日の場合は*
month 月 … <1-12>、毎月の場合は*
week start 週(始め) … [sunday | monday | tuesday | wednesday | thursday | friday | saturday]
end 週(終わり) … [sunday | monday | tuesday | wednesday | thursday | friday | saturday]
order type タイプ … [limit | interface | mobile | syslog | monitor-log | system | firmware | wol | ntp | dns-intercept | config]
action action …

  • limit … clear
  • interface … [connect | disconnect | reconnect]
  • mobile … clear
  • syslog … [rotate | copy]
  • monitor-log … rotate
  • system … [restart | sleep | resume | notify]
  • firmware … [update | check | list-update]
  • wol … send
  • ntp … adjust
  • dns-intercept … update
  • config … copy
option option …

  • limit … pppX
    ※Xはインタフェース番号 (ex. ppp0)
  • interface … pppX
    ※Xはインタフェース番号 (ex. ppp0)
  • mobile … モバイル番号
  • syslog … cms
  • monitor-log … [reachability | resource]
  • system … [timer | schedule | cms]
  • firmware … [URL | official | cms]
    ※URLではファームウェアまたリストの取得先を指定(ex. ftp://192.168.0.1/nxr530-v210601.bin)
  • wol … name
  • dns-intercept … セットネーム
  • config … [URL | cms]
    ※URLではコンフィグの取得先を指定(ex. http://www.example.jp/config.xml)
soption soption …

  • limit … data-usage
  • firmware … [A.B.C.D | X:X::X:X]
    ※送信元IPアドレスを指定
  • system … [<60-31536000>(sec) | <1-255>]
    ※レジューム方法を指定。timer選択時はスリープ時間、schedule選択時はスケジュール番号を指定
  • wol … WOLコンフィグ名
  • dns-intercept … URL
    ※URLではリストファイルの取得先を指定(ex. http://www.example.jp/dnsi-list.xml)
  • copy … [startup-config | config]
toption toption …

  • syslog … [A.B.C.D | X:X::X:X]
    ※送信元IPアドレスを指定
  • system … [A.B.C.D | X:X::X:X]
    ※送信元IPアドレスを指定
  • firmware … hold
  • dns-intercept … [A.B.C.D | X:X::X:X]
    ※送信元IPアドレスを指定
  • copy … [A.B.C.D | X:X::X:X]
    ※送信元IPアドレスを指定
foption foption …

  • syslog … <30-86400>(sec)
    ※マージンを指定
  • system … <30-86400>(sec)
    ※マージンを指定
  • firmware … <30-86400>(sec)
    ※マージンを指定
  • copy … <30-86400>(sec)
    ※マージンを指定
password hidden 暗号化 … [enable | disable]
passphrase パスワード
apply 暗号化適用 … [enable | disable]
※hidden化する場合は必要