FutureNet

NXR,VXRシリーズ

REST-API編

8. 各種サービス設定

8-23. SIP-NAT設定(sip-nat)

 処理概要

SIP-NAT設定に関する処理を実行します。

 

URIおよびメソッド

機能 Version URI メソッド
POST PUT GET DELETE
SIP-NAT v2 /api/v2/sip-nat

凡例:

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

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

- : 未対応

 

実行例

SIP-NAT設定の更新

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

 

JSON
リクエスト

PUT /api/v2/sip-nat
Content-Type: application/json

 

{
"nat": "enable",
"exclude-interface": "ethernet1"
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/sip-nat
Content-Type: application/xml

 

<sip-nat>
<nat>enable</nat>
<exclude-interface>ethernet1</exclude-interface>
</sip-nat>

 

レスポンス

204 No content

 

SIP-NAT設定の取得

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

GET /api/v2/sip-nat
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"nat": "enable",
"exclude-interface": "ethernet1"
}

 

XML
リクエスト

GET /api/v2/sip-nat
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml


<sip-nat>
<nat>enable</nat>
<exclude-interface>ethernet1</exclude-interface>
</sip-nat>

 

TEXT/PLAIN
リクエスト

GET /api/v2/sip-nat
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

sip-nat enable
sip-nat exclude-interface ethernet 1

 

パラメータ

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

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

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

 

パラメータおよびレベル 説明
Lv.1 Lv.2
sip-nat nat SIP-NAT機能 … [ enable | disable ]
port ポート番号 … <1-65535>
port-translate ポート変換 … [ enable | disable ]
exclude-interface 除外インタフェース(ex. ethernet0)