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

FutureNet

NXR,VXRシリーズ

REST-API編

2. メンテナンス

2-14. traceroute（IPv4）の実行・結果確認（maint/traceroute）

 処理概要

traceroute（IPv4）に関する処理を実行します。

 

URIおよびメソッド

機能 Version URI メソッド
POST PUT GET DELETE
traceroute(IPv4) v2 /api/v2/maint/traceroute ● － ● －
/api/v2/maint/traceroute/{ID} ● － ● ●

凡例：

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

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

－ : 未対応

 

実行例

tracerouteの実行

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

POST /api/v2/maint/traceroute
Accept: application/json
Content-Type: application/json

 

{
"dst": "203.0.113.1",
"src": "192.168.10.1",
"protocol": "icmp"
}

 

レスポンス

202 Accepted
Content-Type: application/json

 

{
"exec-id": "1234",
"expire": 600
}

 

 

XML
リクエスト

POST /api/v2/maint/traceroute
Accept: application/xml
Content-Type: application/xml

 

<config>
<dst>203.0.113.1</dst>
<src>192.168.10.1</src>
<protocol>icmp</protocol>
</config>

 

レスポンス

202 Accepted
Content-Type: application/xml

 

<traceroute>
<exec-id>1234</exec-id>
<expire>600</expire>
</traceroute>

 

tracerouteの実行IDの一覧取得

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

GET /api/v2/maint/traceroute
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
“exec-id”: [
“1234”,
“5678”
]
}

 

XML
リクエスト

GET /api/v2/maint/traceroute
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<traceroute>
<exec-id>1234</exec-id>
<exec-id>5678</exec-id>
</traceroute>

 

TEXT/PLAIN
リクエスト

GET /api/v2/maint/traceroute
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

exec-id : 1234
exec-id : 5678

 

tracerouteの実行（実行ID指定）

メソッド URI
POST /api/v2/maint/traceroute/{ID}
  • 実行ID（exec-id）は、0000 ～ ffffまでの4桁の16進数を指定。

 

JSON
リクエスト

POST /api/v2/maint/traceroute/0001
Accept: application/json
Content-Type: application/json

 

{
"dst": "203.0.113.1",
"src": "192.168.10.1",
"protocol": "icmp"
}

 

レスポンス

202 Accepted
Content-Type: application/json

 

{
"exec-id": "0001",
"expire": 600
}

 

 

XML
リクエスト

POST /api/v2/maint/traceroute/0001
Accept: application/xml
Content-Type: application/xml

 

<config>
<dst>203.0.113.1</dst>
<src>192.168.10.1</src>
<protocol>icmp</protocol>
</config>

 

レスポンス

202 Accepted
Content-Type: application/xml

 

<traceroute>
<exec-id>0001</exec-id>
<expire>600</expire>
</traceroute>

 

tracerouteの実行結果の取得

メソッド URI
GET /api/v2/maint/traceroute/{ID}
  • 実行ID（exec-id）は、0000 ～ ffffまでの4桁の16進数を指定。

 

TEXT/PLAIN
リクエスト

GET /api/v2/maint/traceroute/0001
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

[started: 2023/03/03 15:30:39]
traceroute to 203.0.113.1 (203.0.113.1), 30 hops max, 60 byte packets
1 192.0.2.100 5.920 ms 5.711 ms 5.784 ms
2 192.0.2.254 9.662 ms 9.818 ms 9.790 ms
3 198.51.100.1 5.269 ms 5.332 ms 5.452 ms
4 198.51.100.10 6.436 ms 6.512 ms 6.483 ms
5 203.0.113.254 6.500 ms 6.471 ms 6.807 ms
6 203.0.113.1 6.458 ms 3.431 ms 3.533 ms

 

tracerouteの実行停止・結果の削除

メソッド URI
DELETE /api/v2/maint/traceroute/{ID}
リクエスト

DELETE /api/v2/maint/traceroute/0001

 

レスポンス

204 No content

 

パラメータ

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

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

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

 

パラメータおよびレベル 説明
Lv.1 Lv.2
config dst 宛先アドレス …

  • A.B.C.D
  • FQDN
src 送信元IPアドレス … A.B.C.D
※interfaceとの同時指定不可。同時指定時はsrc設定が優先
interface 送信元インタフェース名（ex. ethernet0, ethernet0.Y 〔YはVLAN ID〕）
※srcとの同時指定不可。同時指定時はsrc設定が優先
protocol プロトコル … [ icmp | tcp | udp ]
port ポート番号, シーケンス番号（ICMP） … <1-65535(プロトコル未指定〔33434〕, icmp〔1〕, tcp〔80〕, udp〔53〕)>
※プロトコル未指定、icmp時は番号をインクリメントする。
wait 待ち時間 … <1-10(5)>（sec）
ttl TTL … <1-255(30)>