汎用 API データ・ソースからのウィジェットの作成

汎用 API を使用して、 IBM® QRadar® API および公開された API を使用する QRadar アプリケーションからデータを取り出すウィジェットを作成できます。

このタスクについて

API は、JSON 配列 (複数の結果がある場合) または JSON オブジェクト (1 つの結果のみがある場合) のいずれかを返します。 返された JSON オブジェクトは、1 つのエレメントを含む JSON 配列に変換されます。

手順

  1. ダッシュボードの構成をクリックします。

    「ダッシュボードの構成」 画面に、使用可能なウィジェットのライブラリーがそれぞれの詳細とともに表示されます。

  2. 新規ウィジェットの作成をクリックします。
  3. 「 新規ダッシュボード項目 」ページで、ウィジェットの名前と説明を入力します。
  4. 照会 セクションのデータ・ソース・リストから 汎用 API を選択し、以下のいずれかの例のような API エンドポイントを入力します。
    • /api/asset_model/assets
    • /api/health_data/top_rules
    • /api/config/deployment/hosts
    • /api/config/event_sources/log_source_management/log_sources
    • /console/plugins/<QDI_appId>/app_proxy/comp_status_feed?timediff=471 ( 「結果マッピング」に data と入力します)。
      注： QDIのバージョンによって URL が異なる場合があります。

    詳しくは、「ダッシュボード・グラフ用に汎用 API 照会を作成するためのヒント」を参照してください。

  5. オプション: 汎用 API 照会にパラメーターを追加します。
    1. ステートメントに既存のパラメーターを挿入します。 パラメーターの挿入アイコンをクリックし、関連するパラメーターごとに「挿入」をクリックします。
    2. パラメーターのデフォルト値を変更するには、 パラメーターの表示 アイコンをクリックし、デフォルト値を設定した後で 保存 をクリックします。
      パラメーターのデフォルト値を変更すると、展開またはピン留めされたダッシュボードおよびウィジェットを除き、ワークスペース内でパラメーターが使用されるすべての場所で値が変更されます。 値をデフォルト値として設定しない場合は、更新された変更は現行セッションにのみ適用されます。 ただし、値をデフォルトとして設定する場合は、現行セッションの値でもその値が使用されます。

      事前定義された SYSTEM:username パラメーターは、ログインしているユーザーのユーザー名を返します。 システム・パラメーターは読み取り専用であり、デフォルト値を変更することはできません。

    3. ワークスペースにパラメーターを追加するには、 追加をクリックし、パラメーターに名前とデフォルト値を指定し (必要な場合)、 保存をクリックします。

      ダッシュボードのウィジェットに初めてパラメーターを追加すると、ダッシュボードに「パラメーター」カードが表示されます。 ウィジェットからパラメーターを削除し、ダッシュボード内にそのパラメーターを使用するウィジェットがそれ以上ない場合は、パラメーター・カードは表示されなくなります。

  6. データ・ソースをポーリングする頻度を示すリフレッシュ時間を選択してください。 デフォルトのリフレッシュ時間は 5 分ごとです。 リフレッシュ時間が短いほど、 IBM QRadarのパフォーマンスへの影響が大きくなります。 リフレッシュ時間は、照会の完了後に開始します。
    例えば、照会の完了に 3 分かかる場合、3 分間の実行が終了した後で初めてリフレッシュ時間が開始します。
  7. 返された JSON 内のルート・オブジェクトが、プロットする配列でない場合は、 結果マッピング を入力して、プロットする関連データを含むキーを定義します。 詳しくは、 ダッシュボード・グラフの汎用 API 照会の作成のヒントを参照してください。
  8. オプション: 返された JSON にタイトル・マッピングが含まれている場合は、 結果セットのタイトルを使用 を オンに設定します。 詳しくは、 ダッシュボード・グラフの汎用 API 照会の作成のヒントを参照してください。
  9. 照会の実行をクリックします。
    最初にウィジェットを作成するときに、データ結果が返されない場合はグラフを構成できません。 フィールドの条件をあまり厳しくないものにして、照会を再実行してください。
  10. ビュー セクションでダッシュボード・グラフを作成します。
    同じ照会から複数のビューおよびグラフを作成できるため、ビューには固有の名前を付けてください。 デフォルトでは、タイトル・バーにあるグラフのタイトルと状況が表示されます。それらを非表示にするには、その他のオプション・アイコンをクリックして、設定を「オフ」に切り替えます。
  11. グラフ・タイプを選択し、関連プロパティーを構成します。 使用するグラフ・タイプを決定するのに役立つユース・ケースについては、 ウィジェット・グラフ・タイプを参照してください。
    グラフ・タイプ 注意事項
    棒 棒グラフの作成
    ビッグ・ナンバー ビッグ・ナンバー・チャートの作成
    地理 地理的グラフの作成
    円 円グラフの作成
    散布 散布グラフの作成
    表形式 表形式のチャートの作成
    時系列 (Time Series) 時系列グラフの作成
  12. グラフの外観をプレビューし、 保存をクリックします。
    ヒント: グラフのラベルは使用されている照会から取得されます。 プレビューでわかりにくい場合は、「ビュー」セクションでラベルを編集します。