ODataAPI QueryBuilder の使用

ODataAPIQueryBuilder は、設定およびフロー データをエクスポートするクエリ URL を作成します。
nfa1003
HID_ODataAPI_QueryBuilder
QueryBuilder は、設定およびポーリングされたデータをエクスポートするクエリ URL を作成します。
3
NFA ODataAPI QueryBuilder ユーザ インターフェース
以下の図は、NFA ODataAPI QueryBuilder のユーザ インターフェースを示しています。
NFAQueryBuilderUI
QueryBuilder インターフェースおよび結果について
クエリを作成するには、[
Query Expression (クエリ式)
]フィールドを使用します。 アプリケーションはクエリの URL を作成し、
[OData URL]
セクションにその URL を表示します。
[Table - Results (テーブル - 結果)]
セクションには、クエリの結果が表示されます。 結果テーブルは、昇順または降順でソートできます。 任意の列を選択し、結果テーブルをカスタマイズして、目的の列のみを表示できます。 また、さらに結果があれば、
[Table - Results (テーブル - 結果)]
セクションの下部にある矢印ボタンを使用してそれらを表示できます。 クリップボード アイコンをクリックして、結果を別のアプリケーションにコピーします。 結果を CSV 形式でエクスポートするには、
[CSV へエクスポート]アイコンをクリックします。 NFA ODataAPI QueryBuilder ドキュメントを参照するには、? (ヘルプ)リンクをクリックします。
詳細
ODataAPI クエリの作成
データ ソースからカスタマイズされたデータ セットを抽出するには、QueryBuilder を使用して、ODataAPI クエリを生成します。
大きな結果セットを返すクエリは、システムに悪影響を及ぼす可能性があります。 要求に関連する結果のみを返すようにクエリを改良することをお勧めします。
Web ブラウザのアドレス バーが更新され、選択したトークンが[Query Expression (クエリ式)]フィールドに表示されます。 後でクエリの編集を続行するには、この URL をコピーして保存します。
以下の手順に従います。
  1. クエリを開始するには、[Query Expression (クエリ式)]フィールドをクリックします。
  2. データ セットの目的を表すオプションとして、
    for
    を選択します。
  3. select
    expand
    、および
    filter
    トークンを追加して、出力データを定義します。
  4. 結果を絞り込むには、より多くのトークンを追加します。
    QueryBuilder は OData URL を作成します。
  5. Odata クエリの実行
    - QueryBuilder ブラウザ ウィンドウでクエリを実行するには、
    [実行]
    をクリックします。
  6. OData URL をクリップボードにコピー
    - 使用可能な式を使用してクエリを作成した後、
    Odata URL
    を選択し、
    [Copy to clipboard (クリップボードにコピー)]
    をクリックして、Web ブラウザ、REST ツール、またはカスタム アプリケーションからクエリを実行します。
    レポートでは、クエリの結果がテーブルに表示されます。
NFA QueryBuilder ODataAPI コントロール
QueryBuilder は、ODataAPI クエリ構文で論理エレメントを表すトークンを使用します。 [Query Expression (クエリ式)]フィールドをクリックすると、トークンが表示されます。 トークンを使用すると、選択したエンティティに対して使用可能なプロパティのタイプを選択できます。 トークンを選択すると、クエリ URL が更新されます。
以下のコントロールを使用して、Query URL を作成およびエクスポートします。
  • for
    このトークンは、クエリがデータを取得するエンティティのタイプを決定します。 このトークンは、各クエリに 1 回だけ表示されます。
    このトークンに関するほとんどのオプションには、自動フィルタを設定する選択が含まれています。 たとえば、トークンでインターフェースを選択すると、expand トークン オプションが表示されます。 ルータを選択する場合は、expand トークン オプションは使用できません。
  • expand
    expand トークンは、インラインで表示する必要がある関連エンティティおよびストリーム値を示します。 CA NFA OData サービスは指定されたコンテンツを返し、追加情報を返す場合があります。
  • navigation
    navigation トークンは、CA Network Flow Analysis コンソールのユーザ インターフェースに似ています。 ナビゲーション プロパティ名の後には、必要に応じて /$count パス セグメントを指定し、必要に応じて関連するエンティティのフィルタリング、並べ替え、選択、ページング、展開などの、かっこ付きの展開オプション セットを指定できます。
    QueryBuilder は現在、2 レベルまでのナビゲーションをサポートしています。
  • select
    このトークンは、データ セットに含める項目プロパティを決定します。 結果ではプロパティの順序がサポートされません。
  • フィルタ
    このトークンは、AND および OR 演算子を使用して、論理関数に基づくカスタム フィルタを追加します。 フィルタがすべての論理関数に対して大文字と小文字を区別するかどうかを選択します。 OData がフィルタ式を評価する場合、「Any」演算子を使用して、アイテムのコレクションに対してブール式が True か False かを判断します。 以下の例では、True が返されます。
    odata/api/interfaces?$filter=((ID eq 10) and (contains(RouterAddress,'10.0.0.19'))
  • カスタム パラメータ
    このトークンは、OData 構文のカスタム パラメータをクエリに追加します。
  • sort
    このトークンは、クエリ出力の並べ替えを制御します。 たとえば、以下のクエリは、ID でインターフェース エンティティを並べ替えます。
    /interfaces?$orderby=ID
  • limit (top)
    このトークンは、クエリ出力内の行または展開された行の最大数を指定します。
    • 行の最大数:
      結果テーブル内の行数
    • スキップする行数:
      クエリ出力から除外する先行行の数
  • format
    このトークンは、返されたデータ セットの形式を決定します。 ODataAPI は、HTML 形式をサポートしています。
    HTML Table
    クエリにこのトークンが含まれていない場合、HTML テーブルがデフォルトの形式になります。
    HTML テーブル形式は、ODataAPI QueryBuilder でのみサポートされています。 直接の ODataAPI クエリでは、HTML および JSON がサポートされます。
クエリ結果のエクスポート
クエリ結果は CSV 形式でダウンロードできます。
例:
以下の手順を使用すると、インターフェースの選択されたプロパティのレポートをダウンロードできます。
以下の手順に従います。
  1. [Query Expression (クエリ式)]フィールドで、以下のクエリ オプションを選択します。
    1. for: interfaces
    2. select: AgentType,Description,Enabled,HarvesterAddress,ID,IfIndex
  2. [実行]
    を選択して、クエリを実行します。
  3. クエリ結果を CSV 形式でエクスポートするには、NFAQueryBuilderExportCSV ボタンを選択します。
レポートは、デフォルトのダウンロード ディレクトリに CSV 形式で保存されます。