FutureNet

NXR,VXRシリーズ

REST-API編

8. 各種サービス設定

8-16. DDNS設定(ddns)

 処理概要

DDNS設定に関する処理を実行します。

 

URIおよびメソッド

機能 Version URI メソッド
POST PUT GET DELETE
DDNS v2 /api/v2/ddns

凡例:

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

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

- : 未対応

 

実行例

DDNS設定の作成

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

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

 

{
"service": "enable",
"ddns-provider": "http-client",
"account": {
"username": "ddnsuser",
"password": {
"passphrase": "ddnspassword"
}
},
"bind-interface": "ethernet1",
"forced-update-interval": 1,
"http-client": {
"address-family": "ip",
"url": "http://ddns.example.com/login.html",
"query": "ddns"
}
}

 

レスポンス

201 Created

 

XML
リクエスト

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

 

<ddns>
<service>enable</service>
<ddns-provider>http-client</ddns-provider>
<account>
<username>ddnsuser</username>
<password>
<passphrase>ddnspassword</passphrase>
</password>
</account>
<bind-interface>ethernet1</bind-interface>
<forced-update-interval>1</forced-update-interval>
<http-client>
<address-family>ip</address-family>
<url>http://ddns.example.com/login.html</url>
<query>ddns</query>
</http-client>
</ddns>

 

レスポンス

201 Created

 

DDNS設定の更新

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

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

 

{
"service": "enable",
"ddns-provider": "http-client",
"account": {
"username": "ddnsuser",
"password": {
"passphrase": "ddnspassword"
}
},
"bind-interface": "ethernet1",
"forced-update-interval": {
"@unit": "minutes",
"#text": 30
},
"http-client": {
"address-family": "ip",
"url": "http://ddns.example.com/login.html",
"query": "ddns"
}
}

 

レスポンス

204 No content

 

XML
リクエスト

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


<ddns>
<service>enable</service>
<ddns-provider>http-client</ddns-provider>
<account>
<username>ddnsuser</username>
<password>
<passphrase>ddnspassword</passphrase>
</password>
</account>
<bind-interface>ethernet1</bind-interface>
<forced-update-interval unit="minutes">30</forced-update-interval>
<http-client>
<address-family>ip</address-family>
<url>http://ddns.example.com/login.html</url>
<query>ddns</query>
</http-client>
</ddns>

 

レスポンス

204 No content

 

DDNS設定の取得

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

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

 

レスポンス

200 OK
Content-Type: application/json

 

{
"service": "enable",
"ddns-provider": "http-client",
"account": {
"username": "ddnsuser",
"password": {
"passphrase": "ddnspassword"
}
},
"bind-interface": "ethernet1",
"forced-update-interval": {
"@unit": "minutes",
"#text": 30
},
"http-client": {
"address-family": "ip",
"url": "http://ddns.example.com/login.html",
"query": "ddns"
}
}

 

XML
リクエスト

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

 

レスポンス

200 OK
Content-Type: application/xml


<ddns>
<service>enable</service>
<ddns-provider>http-client</ddns-provider>
<account>
<username>ddnsuser</username>
<password>
<passphrase>ddnspassword</passphrase>
</password>
</account>
<bind-interface>ethernet1</bind-interface>
<forced-update-interval unit="minutes">30</forced-update-interval>
<http-client>
<address-family>ip</address-family>
<url>http://ddns.example.com/login.html</url>
<query>ddns</query>
</http-client>
</ddns>

 

TEXT/PLAIN
リクエスト

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

 

レスポンス

200 OK
Content-Type: text/plain

 

ddns
service enable
ddns-provider http-client
account username ddnsuser password ddnspassword
bind-interface ethernet 1
url ip http://ddns.example.com/login.html
query ddns
forced-update-interval 30 minutes

 

DDNS設定の削除

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

DELETE /api/v2/ddns

 

レスポンス

204 No content

 

パラメータ

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

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

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

 

パラメータおよびレベル 説明
Lv.1 Lv.2 Lv.3 Lv.4 Lv.5
ddns service DDNS機能 … [ enable | disable ]
account username ユーザ名
password hidden 暗号化 … [ enable | disable ]
passphrase パスワード
apply 暗号化適用 … [ enable | disable ]
※hidden化する場合は必要
bind-interface 接続回線インターフェース(ex. ethernet0)
ddns-provider DDNSプロバイダ … [ dococame | dtdns | dyndns | http-client | no-ip | ocn-ipoe ]
domain-list domain ドメイン名
forced-update-interval 強制更新間隔 … 

  • <0-720>(Hours)
  • <0-43200>(Minutes)
    ※XMLの場合<forced-update-interval unit=”minutes”>で指定
    ※JSONの場合下記のように指定
    “@unit”: “minutes”
    “#text”: 30
http-client address-family アドレスファミリ … [ ip | ipv6 ]
url DDNSサーバURL (ex. http://example.com)
query HTTPクエリ
client id DDNSクライアントID
account username ユーザ名
password hidden 暗号化 … [ enable | disable ]
passphrase パスワード
apply 暗号化適用 … [ enable | disable ]
※hidden化する場合は必要
bind-interface 接続回線インターフェース(ex. ethernet0)
provider name DDNSプロバイダ … [ dyndns | http-client | no-ip ]
address-family アドレスファミリ … [ ip | ipv6 ]
scheme スキーム … [ http | https ]
domain-list domain ドメイン名
update-interval 強制更新間隔 … <0-43200>(Minutes)
update-source 送信元指定 … interface
netevent track-id トラックID
action ネットイベントアクション … [ active | inactive ]
http-client address-family アドレスファミリ … [ ip | ipv6 ]
url DDNSサーバURL (ex. http://example.com)
query HTTPクエリ