FutureNet

NXR,VXRシリーズ

REST-API編

8. 各種サービス設定

8-13. HTTPサーバ設定(http)

 処理概要

HTTPサーバ設定に関する処理を実行します。

 

URIおよびメソッド

機能 Version URI メソッド
POST PUT GET DELETE
HTTP Server v2 /api/v2/http

凡例:

● : 読み取り専用ユーザも含めアクセス可

〇 : 読み取り専用ユーザはアクセス不可

- : 未対応

 

実行例

HTTPサーバ設定の更新

メソッド URI
PUT /api/v2/http
  • Bodyを指定しなかった場合、設定の削除およびサーバを停止します。

 

JSON
リクエスト

PUT /api/v2/http
Content-Type: application/json

 

{
"server": "enable",
"filter": {
"ipv4-name": "http_acl"
}
}

 

レスポンス

204 No content
※http-serverの停止・起動が伴う場合、エラー表示になる場合がなります。そのため、設定の反映状況は、GETメソッドで確認してください。

 

XML
リクエスト

PUT /api/v2/http
Content-Type: application/xml

 

<http>
<server>enable</server>
<filter>
<ipv4-name>http_acl</ipv4-name>
</filter>
</http>

 

レスポンス

204 No content

※http-serverの停止・起動が伴う場合、エラー表示になる場合がなります。そのため、設定の反映状況は、GETメソッドで確認してください。

 

HTTPサーバ設定の取得

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

GET /api/v2/http
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"server": "enable",
"filter": {
"ipv4-name": "http_acl"
}
}

 

XML
リクエスト

GET /api/v2/http
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<http>
<server>enable</server>
<filter>
<ipv4-name>http_acl</ipv4-name>
</filter>
</http>

 

TEXT/PLAIN
リクエスト

GET /api/v2/http
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

http-server enable
http-server ip access-filter http_acl

 

パラメータ

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

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

  • パラメータ表の説明文中の記号について
    [ ] … 括弧内の値のどれかを選択することを示しています。
    数字,文字列 … 初期値

 

パラメータおよびレベル 説明
Lv.1 Lv.2 Lv.3 Lv.4
global http server HTTPサーバ機能 … [ enable | disable ]
※初期コンフィグでenable
timeout タイムアウト値 … <5-300>(sec)
max-clients 最大接続数 … <5-200>
keepalive-param keepalive キープアライブ … [ enable | disable ]
timeout キープアライブのタイムアウト値 … <5-60(15)>(sec)
max-requests 最大リクエスト数 … <10-100>
filter ipv4-name IPv4 HTTPアクセスフィルタ … ACL名
ipv6-name IPv6 HTTPアクセスフィルタ … ACL名
forbidden-access-wan  ipv4 forbidden-access-wan(IPv4) … [ enable | disable ]
ipv6 forbidden-access-wan(IPv6) … [ enable | disable ]