FutureNet

NXR,VXRシリーズ

REST-API編

8. 各種サービス設定

8-15. DNSインターセプト設定(dns-intercept)

処理概要

DNSインターセプト設定に関する処理を実行します。

 

URIおよびメソッド

機能 Version URI メソッド
POST PUT GET DELETE
dns-intercept v2 /api/v2/dns-intercept
/api/v2/dns-intercept/interceptors
/api/v2/dns-intercept/interceptors/interceptor
/api/v2/dns-intercept/interceptors/interceptor/{NUM}
/api/v2/dns-intercept/ipset-list
/api/v2/dns-intercept/ipset-list/ipset
/api/v2/dns-intercept/ipset-list/ipset/{NAME}

凡例:

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

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

- : 未対応

 

実行例

DNSインターセプト設定の作成

メソッド URI
POST /api/v2/dns-intercept/interceptors/interceptor
JSON
リクエスト

POST /api/v2/dns-intercept/interceptors/interceptor
Content-Type: application/json

 

{
"interceptor": {
"number": 0,
"dns-address": "192.0.2.1",
"match": {
"family": "ip",
"setname": "DNSI"
}
}
}

 

レスポンス

201 Created

 

XML
リクエスト

POST /api/v2/dns-intercept/interceptors/interceptor
Content-Type: application/xml

 

<interceptors>
<interceptor>
<number>0</number>
<dns-address>192.0.2.1</dns-address>
<match>
<family>ip</family>
<setname>DNSI</setname>
</match>
</interceptor>
</interceptors>

 

レスポンス

201 Created

 

全DNSインターセプト設定の取得

メソッド URI
GET /api/v2/dns-intercept/interceptors/interceptor
JSON
リクエスト

GET /api/v2/dns-intercept/interceptors/interceptor
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"interceptor": [
{
"number": 0,
"dns-address": "192.0.2.1",
"match": {
"family": "ip",
"setname": "DNSI"
}
},
{
"number": 1,
"dns-address": "192.0.2.11",
"match": {
"family": "ip",
"setname": "DNSI"
}
}
]
}

 

XML
リクエスト

GET /api/v2/dns-intercept/interceptors/interceptor
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<interceptors>
<interceptor>
<number>0</number>
<dns-address>192.0.2.1</dns-address>
<match>
<family>ip</family>
<setname>DNSI</setname>
</match>
</interceptor>
<interceptor>
<number>1</number>
<dns-address>192.0.2.11</dns-address>
<match>
<family>ip</family>
<setname>DNSI</setname>
</match>
</interceptor>
</interceptors>

 

TEXT/PLAIN
リクエスト

GET /api/v2/dns-intercept/interceptors/interceptor
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

dns-intercept 0
address 192.0.2.1
match ip setname DNSI
dns-intercept 1
address 192.0.2.11
match ip setname DNSI

 

DNSインターセプト設定の更新

メソッド URI
PUT /api/v2/dns-intercept/interceptors/interceptor/{NUM}
JSON
リクエスト

PUT /api/v2/dns-intercept/interceptors/interceptor/0
Content-Type: application/json

 

{
"number": 0,
"dns-address": [
"192.0.2.1",
"192.0.2.2"
],
"match": {
"family": "ip",
"setname": "DNSI"
}
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/dns-intercept/interceptors/interceptor/0
Content-Type: application/xml

 

<interceptor>
<number>0</number>
<dns-address>192.0.2.1</dns-address>
<dns-address>192.0.2.2</dns-address>
<match>
<family>ip</family>
<setname>DNSI</setname>
</match>
</interceptor>

 

レスポンス

204 No content

 

DNSインターセプト設定の取得

メソッド URI
GET /api/v2/dns-intercept/interceptors/interceptor/{NUM}
JSON
リクエスト

GET /api/v2/dns-intercept/interceptors/interceptor/0
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"number": 0,
"dns-address": [
"192.0.2.1",
"192.0.2.2"
],
"match": {
"family": "ip",
"setname": "DNSI"
}
}

 

XML
リクエスト

GET /api/v2/dns-intercept/interceptors/interceptor/0
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<interceptor>
<number>0</number>
<dns-address>192.0.2.1</dns-address>
<dns-address>192.0.2.2</dns-address>
<match>
<family>ip</family>
<setname>DNSI</setname>
</match>
</interceptor>

 

TEXT/PLAIN
リクエスト

GET /api/v2/dns-intercept/interceptors/interceptor/0
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

dns-intercept 0
address 192.0.2.1
address 192.0.2.2
match ip setname DNSI

 

DNSインターセプト設定の削除

メソッド URI
DELETE /api/v2/dns-intercept/interceptors/interceptor/{NUM}
リクエスト

DELETE /api/v2/dns-intercept/interceptors/interceptor/0

 

レスポンス

204 No content

 

DNSインターセプトsetname設定の作成

メソッド URI
POST /api/v2/dns-intercept/ipset-list/ipset
JSON
リクエスト

POST /api/v2/dns-intercept/ipset-list/ipset
Content-Type: application/json

 

{
"ipset": {
"setname": "DNSI",
"type": "file"
}
}

 

レスポンス

201 Created

 

XML
リクエスト

POST /api/v2/dns-intercept/ipset-list/ipset
Content-Type: application/xml

 

<ipset-list>
<ipset>
<setname>DNSI</setname>
<type>file</type>
</ipset>
</ipset-list>

 

レスポンス

201 Created

 

全DNSインターセプトsetname設定の取得

メソッド URI
GET /api/v2/dns-intercept/ipset-list/ipset
JSON
リクエスト

GET /api/v2/dns-intercept/ipset-list/ipset
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"ipset": [
{
"setname": "DNSI",
"type": "file"
},
{
"setname": "DNSI2",
"type": "file"
}
]
}

 

XML
リクエスト

GET /api/v2/dns-intercept/ipset-list/ipset
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<ipset-list>
<ipset>
<setname>DNSI</setname>
<type>file</type>
</ipset>
<ipset>
<setname>DNSI2</setname>
<type>file</type>
</ipset>
</ipset-list>

 

TEXT/PLAIN
リクエスト

GET /api/v2/dns-intercept/ipset-list/ipset
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

ip dns-intercept setname DNSI file
ip dns-intercept setname DNSI2 file

 

DNSインターセプトsetname設定の取得

メソッド URI
GET /api/v2/dns-intercept/ipset-list/ipset/{NAME}
JSON
リクエスト

GET /api/v2/dns-intercept/ipset-list/ipset/DNSI
Content-Type: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
“setname”: “DNSI”,
“type”: “file”
}

 

XML
リクエスト

GET /api/v2/dns-intercept/ipset-list/ipset/DNSI
Content-Type: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<ipset>
<setname>DNSI</setname>
<type>file</type>
</ipset>

 

TEXT/PLAIN
リクエスト

GET /api/v2/dns-intercept/ipset-list/ipset/DNSI
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

ip dns-intercept setname DNSI file

 

DNSインターセプトsetname設定の削除

メソッド URI
DELETE /api/v2/dns-intercept/ipset-list/ipset/{NAME}
リクエスト

DELETE /api/v2/dns-intercept/ipset-list/ipset/DNSI

 

レスポンス

204 No content

 

パラメータ

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

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

  • パラメータ表の説明文中の記号について
    < > … 括弧内の値の範囲から選択することを示しています
    [ ] … 括弧内の値のどれかを選択することを示しています
    数字,文字列 … 初期値
  • パラメータ表の説明文中のデータタイプについて
    A.B.C.D … IPv4アドレス

 

パラメータおよびレベル 説明
Lv.1 Lv.2 Lv.3 Lv.4 Lv.5
dns-intercept interceptors interceptor number インターセプト設定番号
dns-address インターセプト対象DNSサーバアドレス … A.B.C.D
listen protocol DNSパケットlistenプロトコル … udp
src-port 送信元ポート番号 … <1-65535(53)>
local-port ローカルポート番号 … <49152-65535(50053)>
match family アドレスファミリ … ip
setname set名
min-ttl 最小TTL … <120-4294967>(sec)
max-ttl 最大TTL … <120-4294967>(sec)
ipset-list ipset setname set名
type リストタイプ … file
popt オプション … ms-o365