1. FutureNet製品活用ガイド
  2. FutureNet NXR,VXRシリーズ
  3. REST-API編

FutureNet

NXR,VXRシリーズ

REST-API編

8. 各種サービス設定

8-27. speed-test設定（speed-test）

 処理概要

speed-test設定に関する処理を実行します。

 

URIおよびメソッド

機能 Version URI メソッド
POST PUT GET DELETE
Speed Test v2 /api/v2/speed-test － － － －
/api/v2/speed-test/condition-list － － － －
/api/v2/speed-test/condition-list/condition 〇 － 〇 －
/api/v2/speed-test/condition-list/condition/{NUM} － 〇 〇 〇

凡例：〇対応、－未対応

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

 

実行例

speed-test設定の作成

メソッド URI
POST /api/v2/speed-test/condition-list/condition
JSON
リクエスト

POST /api/v2/speed-test/condition-list/condition
Content-Type: application/json

 

{
"condition": {
"number": 1,
"method": "fileload",
"fileload": {
"direction": "down",
"family": "ip",
"peer-url": "http://www.example.com/filename.dat"
}
}
}

 

レスポンス

201 Created

 

XML
リクエスト

POST /api/v2/speed-test/condition-list/condition
Content-Type: application/xml

 

<condition-list>
<condition>
<number>1</number>
<method>fileload</method>
<fileload>
<direction>down</direction>
<family>ip</family>
<peer-url>http://www.example.com/filename.dat</peer-url>
</fileload>
</condition>
</condition-list>

 

レスポンス

201 Created

 

全speed-test設定の取得

メソッド URI
GET /api/v2/speed-test/condition-list/condition
JSON
リクエスト

GET /api/v2/speed-test/condition-list/condition
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"condition": [
{
"number": 1,
"method": "fileload",
"fileload": {
"direction": "down",
"family": "ip",
"peer-url": "http://www.example.com/filename.dat"
}
},
{
"number": 2,
"method": "fileload",
"fileload": {
"direction": "down",
"family": "ip",
"peer-url": "https://www2.example.com/filename.dat"
}
}
]
}

 

XML
リクエスト

GET /api/v2/speed-test/condition-list/condition
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<condition-list>
<condition>
<number>1</number>
<method>fileload</method>
<fileload>
<direction>down</direction>
<family>ip</family>
<peer-url>http://www.example.com/filename.dat</peer-url>
</fileload>
</condition>
<condition>
<number>2</number>
<method>fileload</method>
<fileload>
<direction>down</direction>
<family>ip</family>
<peer-url>https://www2.example.com/filename.dat</peer-url>
</fileload>
</condition>
</condition-list>

 

TEXT/PLAIN
リクエスト

GET /api/v2/speed-test/condition-list/condition
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

speed-test 1
method fileload
fileload down ip http://www.example.com/filename.dat
speed-test 2
method fileload
fileload down ip https://www2.example.com/filename.dat

 

speed-test設定の更新

メソッド URI
PUT /api/v2/speed-test/condition-list/condition/{NUM}
JSON
リクエスト

PUT /api/v2/speed-test/condition-list/condition/1
Content-Type: application/json

 

{
"number": 1,
"method": "fileload",
"target-interface": "ppp0",
"fileload": {
"direction": "down",
"family": "ip",
"peer-url": "http://www.example.com/filename.dat"
}
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/speed-test/condition-list/condition/1
Content-Type: application/xml

 

<condition>
<number>1</number>
<method>fileload</method>
<target-interface>ppp0</target-interface>
<fileload>
<direction>down</direction>
<family>ip</family>
<peer-url>http://www.example.com/filename.dat</peer-url>
</fileload>
</condition>

 

レスポンス

204 No content

 

speed-test設定の取得

メソッド URI
GET /api/v2/speed-test/condition-list/condition/{NUM}
JSON
リクエスト

GET /api/v2/speed-test/condition-list/condition/1
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"number": 1,
"method": "fileload",
"target-interface": "ppp0",
"fileload": {
"direction": "down",
"family": "ip",
"peer-url": "http://www.example.com/filename.dat"
}
}

 

XML
リクエスト

GET /api/v2/speed-test/condition-list/condition/1
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<condition>
<number>1</number>
<method>fileload</method>
<target-interface>ppp0</target-interface>
<fileload>
<direction>down</direction>
<family>ip</family>
<peer-url>http://www.example.com/filename.dat</peer-url>
</fileload>
</condition>

 

TEXT/PLAIN
リクエスト

GET /api/v2/speed-test/condition-list/condition/1
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

speed-test 1
method fileload
fileload down ip http://www.example.com/filename.dat
target-interface ppp 0

 

speed-test設定の削除

メソッド URI
DELETE /api/v2/speed-test/condition-list/condition/{NUM}
リクエスト

DELETE /api/v2/speed-test/condition-list/condition/1

 

レスポンス

204 No content

 

パラメータ

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

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

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

 

パラメータおよびレベル 説明
Lv.1 Lv.2 Lv.3 Lv.4 Lv.5 Lv.6 Lv.7
speed-test condition-list condition number 測定番号 … <0-2>
method 測定方法 … fileload
target-interface 測定対象インタフェース
fileload direction データ転送方向 … down
family アドレスファミリ … ip
peer-url データ転送URL
send-result data-type 測定結果データタイプ … [json | text]
peer-url 測定結果転送先URL
source 送信元アドレス … A.B.C.D