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

FutureNet

NXR,VXRシリーズ

REST-API編

2. メンテナンス

2-15. traceroute（IPv6）の実行・結果確認（maint/traceroute6）

 処理概要

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

 

URIおよびメソッド

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

凡例：

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

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

－ : 未対応

 

実行例

traceroute6の実行

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

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

 

{
"dst": "2001:db8:beef::cafe",
"src": "2001:db8:1::1",
"protocol": "icmp"
}

 

レスポンス

202 Accepted
Content-Type: application/json

 

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

 

 

XML
リクエスト

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

 

<config>
<dst>2001:db8:beef::cafe</dst>
<src>2001:db8:1::1</src>
<protocol>icmp</protocol>
</config>

 

レスポンス

202 Accepted
Content-Type: application/xml

 

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

 

traceroute6の実行IDの一覧取得

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

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

 

レスポンス

200 OK
Content-Type: application/json

 

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

 

XML
リクエスト

GET /api/v2/maint/traceroute6
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/traceroute6
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

exec-id : 1234
exec-id : 5678

 

traceroute6の実行（実行ID指定）

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

 

JSON
リクエスト

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

 

{
"dst": "2001:db8:beef::cafe",
"src": "2001:db8:1::1",
"protocol": "icmp"
}

 

レスポンス

202 Accepted
Content-Type: application/json

 

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

 

 

XML
リクエスト

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

 

<config>
<dst>2001:db8:beef::cafe</dst>
<src>2001:db8:1::1</src>
<protocol>icmp</protocol>
</config>

 

レスポンス

202 Accepted
Content-Type: application/xml

 

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

 

traceroute6の実行結果の取得

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

 

TEXT/PLAIN
リクエスト

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

 

レスポンス

200 OK
Content-Type: text/plain

 

[started: 2023/03/03 16:37:24]
traceroute to 2001:db8:beef::cafe (2001:db8:beef::cafe), 30 hops max, 80 byte packets
1 2001:db8:1234::fffe 2.554 ms 3.763 ms 5.073 ms
2 * * *
3 * * *
4 2001:db8:5678::1 8.556 ms 8.619 ms 8.664 ms
5 * * *
6 2001:db8:9abc::fffe 8.313 ms 6.177 ms 4.936 ms
7 2001:db8:beef::cafe 3.431 ms 3.217 ms 3.051 ms

 

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

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

DELETE /api/v2/maint/traceroute6/0001

 

レスポンス

204 No content

 

パラメータ

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

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

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

 

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

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