FutureNet

NXR,WXRシリーズ

REST-API編

8. 各種サービス設定

8-10. ターミナルサーバ設定(terminal-server)

 処理概要

ターミナルサーバ設定に関する処理を実行します。

 

URIおよびメソッド

機能 Version URI メソッド
POST PUT GET DELETE
Terminal Server v2 /api/v2/terminal-server
/api/v2/terminal-server/server
/api/v2/terminal-server/server/{NUM}

凡例:〇対応、-未対応

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

 

実行例

ターミナルサーバ設定の作成

メソッド URI
POST /api/v2/terminal-server/server
JSON
リクエスト

POST /api/v2/terminal-server/server
Content-Type: application/json

 

{
"server": {
"number": 0,
"baud-rate": 115200,
"transport": "telnet",
"port": 10000
}
}

 

レスポンス

201 Created

 

XML
リクエスト

POST /api/v2/terminal-server/server
Content-Type: application/xml

 

<terminal-server>
<server>
<number>0</number>
<baud-rate>115200</baud-rate>
<transport>telnet</transport>
<port>10000</port>
</server>
</terminal-server>

 

レスポンス

201 Created

 

全ターミナルサーバ設定の取得

メソッド URI
GET /api/v2/terminal-server/server
JSON
リクエスト

GET /api/v2/terminal-server/server
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"server": {
"number": 0,
"baud-rate": 115200,
"transport": "telnet",
"port": 10000
}
}

 

XML
リクエスト

GET /api/v2/terminal-server/server
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<terminal-server>
<server>
<number>0</number>
<baud-rate>115200</baud-rate>
<transport>telnet</transport>
<port>10000</port>
</server>
</terminal-server>

 

TEXT/PLAIN
リクエスト

GET /api/v2/terminal-server/server
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

terminal-server 0
transport telnet
port 10000
baud-rate 115200

 

ターミナルサーバ設定の更新

メソッド URI
PUT /api/v2/terminal-server/server/{NUM}
JSON
リクエスト

PUT /api/v2/terminal-server/server/0
Content-Type: application/json

 

{
"number": 0,
"baud-rate": 115200,
"transport": "telnet",
"port": 10000,
"bind": "192.168.0.1"
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/terminal-server/server/0
Content-Type: application/xml

 

<server>
<number>0</number>
<baud-rate>115200</baud-rate>
<transport>telnet</transport>
<port>10000</port>
<bind>192.168.0.1</bind>
</server>

 

レスポンス

204 No content

 

ターミナルサーバ設定の取得

メソッド URI
GET /api/v2/terminal-server/server/{NUM}
JSON
リクエスト

GET /api/v2/terminal-server/server/0
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"number": 0,
"baud-rate": 115200,
"transport": "telnet",
"port": 10000,
"bind": "192.168.0.1"
}

 

XML
リクエスト

GET /api/v2/terminal-server/server/0
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<server>
<number>0</number>
<baud-rate>115200</baud-rate>
<transport>telnet</transport>
<port>10000</port>
<bind>192.168.0.1</bind>
</server>

 

TEXT/PLAIN
リクエスト

GET /api/v2/terminal-server/server/0
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

terminal-server 0
transport telnet
port 10000
listen address 192.168.0.1
baud-rate 115200

 

ターミナルサーバ設定の削除

メソッド URI
DELETE /api/v2/terminal-server/server/{NUM}
リクエスト

DELETE /api/v2/terminal-server/server/0

 

レスポンス

204 No content