FutureNet

NXR,WXRシリーズ

REST-API編

12. システム設定

12-2. システム設定(system)

 処理概要

省電力などシステム設定に関する処理を実行します。

 

URIおよびメソッド

機能 Version URI メソッド
POST PUT GET DELETE
System v2 /api/v2/system
/api/v2/system/boot
/api/v2/system/netevent
/api/v2/system/clock
/api/v2/system/power-management
/api/v2/system/configuration-id

凡例:〇対応、-未対応

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

 

実行例

system boot設定の更新

メソッド URI
PUT /api/v2/system/boot
  • Bodyを指定しなかった場合、設定を削除します。

 

JSON
リクエスト

PUT /api/v2/system/boot
Content-Type: application/json

 

{
"boot": {
"config": {
"type": "startup-config",
"url": "https://www.example.jp/config.xml"
}
}
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/system/boot
Content-Type: application/xml

 

<system>
<boot>
<config>
<type>startup-config</type>
<url>https://www.example.jp/config.xml</url>
</config>
</boot>
</system>

 

レスポンス

204 No content

 

system boot設定の取得

メソッド URI
GET /api/v2/system/boot
JSON
リクエスト

GET /api/v2/system/boot
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"boot": {
"config": {
"type": "startup-config",
"url": "https://www.example.jp/config.xml"
}
}
}

 

XML
リクエスト

GET /api/v2/system/boot
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<system>
<boot>
<config>
<type>startup-config</type>
<url>https://www.example.jp/config.xml</url>
</config>
</boot>
</system>

 

TEXT/PLAIN
リクエスト

GET /api/v2/system/boot
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

system boot config copy https://www.example.jp/config.xml startup-config

 

system netevent設定の更新

メソッド URI
PUT /api/v2/system/netevent
  • Bodyを指定しなかった場合、設定を削除します。

 

JSON
リクエスト

PUT /api/v2/system/netevent
Content-Type: application/json

 

{
"netevent": {
"track-id": 1,
"action": "restart"
}
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/system/netevent
Content-Type: application/xml

 

<system>
<netevent>
<track-id>1</track-id>
<action>restart</action>
</netevent>
</system>

 

レスポンス

204 No content

 

system netevent設定の取得

メソッド URI
GET /api/v2/system/netevent
JSON
リクエスト

GET /api/v2/system/netevent
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"netevent": {
"track-id": 1,
"action": "restart"
}
}

 

XML
リクエスト

GET /api/v2/system/netevent
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<system>
<netevent>
<track-id>1</track-id>
<action>restart</action>
</netevent>
</system>

 

TEXT/PLAIN
リクエスト

GET /api/v2/system/netevent
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

system netevent 1 restart

 

system clock設定の更新

メソッド URI
PUT /api/v2/system/clock
JSON
リクエスト

PUT /api/v2/system/clock
Content-Type: application/json

 

{
"clock": "mobile1"
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/system/clock
Content-Type: application/xml

 

<system>
<clock>mobile1</clock>
</system>

 

レスポンス

204 No content

 

system clock設定の取得

メソッド URI
GET /api/v2/system/clock
JSON
リクエスト

GET /api/v2/system/clock
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"clock": "mobile1"
}

 

XML
リクエスト

GET /api/v2/system/clock
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<system>
<clock>mobile1</clock>
</system>

 

TEXT/PLAIN
リクエスト

GET /api/v2/system/clock
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

system clock mobile 1

 

system clock設定の削除

メソッド URI
DELETE /api/v2/system/clock

 

リクエスト

DELETE /api/v2/system/clock

 

レスポンス

204 No content

 

system power-management設定の更新

メソッド URI
PUT /api/v2/system/power-management
  • Bodyを指定しなかった場合、設定を削除します。

 

JSON
リクエスト

PUT /api/v2/system/power-management
Content-Type: application/json

 

{
"power-management": {
"mode": "m2m",
"sleep": {
"init": {
"resume-method": "timer",
"resume-option": 3600
}
}
}
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/system/power-management
Content-Type: application/xml

 

<system>
<power-management>
<mode>m2m</mode>
<sleep>
<init>
<resume-method>timer</resume-method>
<resume-option>3600</resume-option>
</init>
</sleep>
</power-management>
</system>

 

レスポンス

204 No content

 

system power-management設定の取得

メソッド URI
GET /api/v2/system/power-management
JSON
リクエスト

GET /api/v2/system/power-management
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"power-management": {
"mode": "m2m",
"sleep": {
"init": {
"resume-method": "timer",
"resume-option": 3600
}
}
}
}

 

XML
リクエスト

GET /api/v2/system/power-management
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<system>
<power-management>
<mode>m2m</mode>
<sleep>
<init>
<resume-method>timer</resume-method>
<resume-option>3600</resume-option>
</init>
</sleep>
</power-management>
</system>

 

TEXT/PLAIN
リクエスト

GET /api/v2/system/power-management
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

system power-management mode m2m
system power-management sleep init-button timer 3600

 

system configuration-id設定の更新

メソッド URI
PUT /api/v2/system/configuration-id
JSON
リクエスト

PUT /api/v2/system/configuration-id
Content-Type: application/json

 

{
"configuration-id": "1234567890abc"
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/system/configuration-id
Content-Type: application/xml

 

<system>
<configuration-id>1234567890abc</configuration-id>
</system>

 

レスポンス

204 No content

 

system configuration-id設定の取得

メソッド URI
GET /api/v2/system/configuration-id
JSON
リクエスト

GET /api/v2/system/configuration-id
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"configuration-id": "1234567890abc"
}

 

XML
リクエスト

GET /api/v2/system/configuration-id
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<system>
<configuration-id>1234567890abc</configuration-id>
</system>

 

TEXT/PLAIN
リクエスト

GET /api/v2/system/configuration-id
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

system configuration-id 1234567890abc

 

system configuration-id設定の削除

メソッド URI
DELETE /api/v2/system/configuration-id

 

リクエスト

DELETE /api/v2/system/configuration-id

 

レスポンス

204 No content