ODataAPI QueryBuilder の例
以下の例は、このような API の柔軟性を示しています。以下の例をモデルとして使用し、独自の ODataAPI クエリを作成します。
nfa1003
以下の例は、このような API の柔軟性を示しています。以下の例をモデルとして使用し、独自の ODataAPI クエリを作成します。
エンティティ情報の抽出
以下の例は、特定の詳細を含むエンティティのリストを抽出する方法を示しています。
フローが有効になっているインターフェースをすべて表示
このクエリを使用して、有効状態にあるすべてのインターフェースを取得するとします。 
このリストを取得するには、以下のトークンを使用してクエリを作成します。
- for: interfaces
- filter: Enabled contains Y
ODataAPI URL:
http://<nfa odata host>:<nfa odata port>/odata/api/interfaces?$filter=contains(Enabled,'Y')
受信速度が高速な上位のインターフェースの表示
インターフェースのリストを、受信速度の降順で並べ替えるとします。 

このリストを取得するには、以下のトークンを使用してクエリを作成します。
- for: interfaces
- sort: Ordering, InSpeed (DESC)
- limit: Top=15, Skip=0
ODataAPI URL:
http://<nfa odata host>:<nfa odata port>/odata/api/interfaces?$orderby=InSpeed desc&$top=15
特定のタイムスタンプ後にデータを受信していないインターフェースの ID の表示
特定の時間の経過後にデータを受信していないすべてのインターフェースのリストが必要だとします。 

このリストを取得するには、以下のトークンを使用してクエリを作成します。
- for: interfaces
- filter: LastData = 1547805618
- select: ID
ODataAPI URL:
http://<nfa odata host>:<nfa odata port>/odata/api/interfaces?$filter = LastData eq 1547805618&$select =ID
同様に、利用可能なインターフェース、ドメイン、テンプレートなどの情報を表示できます。
以下の例は、ナビゲーション トークンを使用してインターフェース情報を抽出する方法を示しています。
指定された時間内のインターフェースの 15 分の集計情報の表示
1569406352 と 1569492720 の間の、ID が 405 のインターフェースについて、15 分間の集計情報を確認したいとします。 

このリストを取得するには、以下のトークンを使用してクエリを作成します。
- for: interface
- navigation: インターフェース Id = 405 と入力し、エンティティ名 = hosts を選択します。
- customparameter: startTime=1569406352&endTime=1569492720&resolution=min15
ODataAPI URL:
http://<nfa odata host>:<nfa odata port>/odata/api/interfaces(405)/hosts?&startTime=1569406352&endTime=1569492720&resolution=min15
指定された時間中のインターフェースの上位 2 つのプロトコル情報の表示
1569406352 と 1569492720 の間の、ID が 405 のインターフェースについて、上位 2 つのプロトコル情報を表示したいとします。 

このリストを取得するには、以下のトークンを使用してクエリを作成します。
- for: interface
- navigation: インターフェース Id = 405 と入力し、エンティティ名 = hosts を選択します。
- customparameter: startTime=1569406352&endTime=1569492720
- limit: 最大行数 = 2、スキップする行数 = 0
ODataAPI URL:
http://<nfa odata host>:<nfa odata port>/odata/api/interfaces(405)/hosts?&startTime=1569406352&endTime=156949272$top=2
指定された時間中のインターフェースの TOS 情報を古い順に並び替えて表示
1569406352 と 1569492720 の間の、ID が 405 のインターフェースについて、上位 2 つのプロトコル情報を表示したいとします。 

このリストを取得するには、以下のトークンを使用してクエリを作成します。
- for: interface
- navigation: インターフェース Id = 405 と入力し、エンティティ名 = hosts を選択します。
- customparameter: startTime=1569406352&endTime=1569492720
- sort: Ordering, tos (DESC)
ODataAPI URL:
http://<nfa odata host>:<nfa odata port>/odata/api/interfaces(405)/toss?&startTime=1569406352&endTime=1569492720&$orderby=tos desc
拡張トークンを使用したインターフェース情報の抽出
以下の例は、拡張トークンを使用してインターフェース情報を抽出する方法を示しています。
特定のインターフェースのプロトコル詳細の表示
インターフェース ID 405 のプロトコルの詳細を確認したいとします。 

このリストを取得するには、以下のトークンを使用してクエリを作成します。
- for: interface
- filter: ID equal 405
- expand: protocols, select=inoctets,outoctets,protocol
ODataAPI URL:
http://<nfa odata host>:<nfa odata port>/odata/api/interfaces?$expand=protocols($select=inoctets,outoctets,protocol)&$filter=((ID eq 405))
インターフェースの通信の詳細を JSON 形式で表示
ID が 405 のインターフェースの通信の詳細を JSON 形式で表示したいとします。 

このデータを取得するには、以下のトークンを使用してクエリを作成します。
- for: interface
- filter: ID equal 405
- expand: conversations($select=DestHost,SrcHost)
- format: JSON
ODataAPI URL:
http://<nfa odata host>:<nfa odata port>/odata/api/interfaces?$expand=conversations&$filter=((ID eq 405))&$format=json
すべてのインターフェースの TOSS 情報の表示
ID が 405 のインターフェースの通信の詳細を JSON 形式で表示したいとします。 

このデータを取得するには、以下のトークンを使用してクエリを作成します。
- for: interface
- expand: toss($select=inoctets,interface)
ODataAPI URL:
http://<nfa odata host>:<nfa odata port>/odata/api/interfaces?$expand=toss($select=inoctets,interface)
特定のエンティティの使用状況に関する情報の取得
プロトコルの使用状況の詳細を表示したいとします。 

このデータを取得するには、以下のトークンを使用してクエリを作成します。
- for: interface
- expand: utilization/ protocol
ODataAPI URL:
http://<nfa odata host>:<nfa odata port>/odata/api/interfaces?$expand=utilization&$apply=groupby((utilization/protocol),aggregate(Utilization))&resolution=MIN1&timeout=120
使用状況レポートは、JSON 形式でのみ表示されます。
設定およびヘルス情報の抽出
以下の例は、一般的なアプリケーション設定およびヘルス情報を抽出する方法を示しています。
全体的なフロー統計の表示
全体的なフロー統計を表示します。 
このデータを取得するには、以下のトークンを使用してクエリを作成します。
- for: flowStats
ODataAPI URL:
http://<nfa odata host>:<nfa odata port>/odata/api/flowStats?
WatchDog 設定の表示
WatchDog 設定を表示します。 
このデータを取得するには、以下のトークンを使用してクエリを作成します。
- for: watchDogSettings
ODataAPI URL:
http://<nfa odata host>:<nfa odata port>/odata/api/watchDogSettings
Harvester のヘルスの表示
harvester のヘルスを表示したいとします。 
このデータを取得するには、以下のトークンを使用してクエリを作成します。
- for: harvesterHealth
ODataAPI URL:
http://<nfa odata host>:<nfa odata port>/odata/api/harvesterHealth
同様に、reporter のヘルスを表示できます。
利用可能な SNMP プロファイルの表示
利用可能な SNMP プロファイルのリストを表示したいとします。 
このデータを取得するには、以下のトークンを使用してクエリを作成します。
- for: snmpprofiles
ODataAPI URL:
http://<nfa odata host>:<nfa odata port>/odata/api/snmpprofiles?
カスタム クエリの実行
カスタム クエリを実行してメタデータを表示したいとします。 

このデータを取得するには、以下のトークンを使用してクエリを作成します。
- for: Custom Query
- Enter a Custom Query: $metadata
ODataAPI URL:
http://<nfa odata host>:<nfa odata port>/odata/api/$metadata
実際のパス情報のみを指定することにより、任意のカスタム クエリを実行できます。