FutureNet

NXR,WXRシリーズ

REST-API編

8. 各種サービス設定

8-2. DNS設定(dns)

 処理概要

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

 

URIおよびメソッド

機能 Version URI メソッド
POST PUT GET DELETE
DNS v2 /api/v2/dns

凡例:〇対応、-未対応

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

 

実行例

DNSサーバ設定の作成

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

POST /api/v2/dns
Content-Type: application/json

 

{
"service": "enable",
"server": [
"203.0.113.1",
"203.0.113.2"
]
}

 

レスポンス

201 Created

 

XML
リクエスト

POST /api/v2/dns
Content-Type: application/xml

 

<dns>
<service>enable</service>
<server>203.0.113.1</server>
<server>203.0.113.2</server>
</dns>

 

レスポンス

201 Created

 

DNSサーバ設定の更新

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

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

 

{
"service": "enable",
"server": [
"203.0.113.1",
"203.0.113.2"
],
"edns_query": "enable"
}

 

レスポンス

204 No content

 

XML
リクエスト

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

 

<dns>
<service>enable</service>
<server>203.0.113.1</server>
<server>203.0.113.2</server>
<edns_query>enable</edns_query>
</dns>

 

レスポンス

204 No content

 

DNSサーバ設定の取得

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

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

 

レスポンス

200 OK
Content-Type: application/json

 

{
"service": "enable",
"server": [
"203.0.113.1",
"203.0.113.2"
],
"edns_query": "enable"
}

 

XML
リクエスト

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

 

レスポンス

200 OK
Content-Type: application/xml

 

<dns>
<service>enable</service>
<server>203.0.113.1</server>
<server>203.0.113.2</server>
<edns_query>enable</edns_query>
</dns>

 

TEXT/PLAIN
リクエスト

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

 

レスポンス

200 OK
Content-Type: text/plain

 

dns
service enable
address 203.0.113.1
address 203.0.113.2
edns-query enable

 

DNSサーバ設定の削除

メソッド URI
DELETE /api/v2/dns
リクエスト

DELETE /api/v2/dns

 

レスポンス

204 No content

 

パラメータ

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

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

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

 

パラメータおよびレベル 説明
Lv.1 Lv.2 Lv.3
dns service DNS機能 … [enable | disable]
server 転送先DNSサーバアドレス …

  • A.B.C.D
  • X:X::X:X
priority type プライオリティ種別 … [dhcp | dhcpv6 | user | ppp<0-4>]
value プライオリティ値 … <0-255>
root ルートDNS転送 … [enable | disable]
timeout タイムアウト時間 … <5-30>(sec)
domain-search ドメインサーチ … [enable | disable]
edns_query EDNS0 … [enable | disable]
limitation DNSサーバ限定 … [enable | disable]
min-ttl 最小TTL … <120-2147483647>(sec)
max-ttl 最大TTL … <120-2147483647>(sec)
host-ttl ip hostで応答するアドレスのTTL … <120-2147483647>(sec)
zone number ゾーン番号 … <1-5>
address アドレス … A.B.C.D
domain ドメイン名
limitation DNSサーバゾーン限定 … [enable | disable]