Widgets aus einer generischen API-Datenquelle erstellen
Sie können die generische API zum Erstellen von Widgets verwenden, die Daten aus IBM® QRadar® -APIs und QRadar -Apps mit verfügbaren APIs abrufen.
Informationen zu dieser Task
APIs geben entweder ein JSON-Array (bei mehreren Ergebnissen) oder ein JSON-Objekt (bei nur einem Ergebnis) zurück. Zurückgegebene JSON-Objekte werden in ein JSON-Array konvertiert, das ein Element enthält.
Vorgehensweise
- Klicken Sie auf Dashboard konfigurieren.
In der Anzeige Dashboard konfigurieren wird eine Bibliothek mit verfügbaren Widgets angezeigt, in der Details zu den einzelnen Widgets angezeigt werden.
- Klicken Sie auf Neues Widget erstellen.
- Geben Sie auf der Seite Neues Dashboardelement einen Namen und eine Beschreibung für das Widget ein.
- Wählen Sie Generische API in der Datenquellenliste im Abschnitt Abfrage aus und geben Sie einen API-Endpunkt ein, wie z. B. eines der folgenden Beispiele:
/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(geben Sie data in Ergebniszuordnungein).Hinweis : URL kann sich je nach QDI-Version ändern.
Weitere Informationen finden Sie im Abschnitt mit den Tipps für die Erstellung von generischen API-Abfragen für Dashboarddiagramme.
- Optional: Parameter zur generischen API-Abfrage hinzufügen.
- Fügen Sie vorhandene Parameter in die Anweisung ein. Klicken Sie auf das Symbol Parameter einfügen und klicken Sie dann für jeden relevanten Parameter auf Einfügen.
- Wenn Sie den Standardwert des Parameters ändern möchten, klicken Sie auf das Symbol Ansichtsparameter und anschließend auf Speichern .Wenn Sie den Standardwert für einen Parameter ändern, ändern Sie den Wert überall dort, wo der Parameter in Ihrem Arbeitsbereich verwendet wird, außer in erweiterten oder angehefteten Dashboards und Widgets. Wenn Sie den Wert nicht als Standardwert festlegen, gilt die aktualisierte Änderung nur für die aktuelle Sitzung. Wenn Sie den Wert jedoch als Standardwert festlegen, verwendet der aktuelle Sitzungswert diesen Wert ebenfalls.
Der vordefinierte Parameter SYSTEM:username gibt den Benutzernamen des angemeldeten Benutzers zurück. Systemparameter sind schreibgeschützt und Sie können den Standardwert nicht ändern.
- Klicken Sie zum Hinzufügen eines Parameters zu Ihrem Arbeitsbereich auf Hinzufügen, geben Sie dem Parameter bei Bedarf einen Namen und einen Standardwert und klicken Sie anschließend auf Speichern.
Nachdem Sie zum ersten Mal Parameter zu einem Widget in einem Dashboard hinzugefügt haben, wird die Parameter-Karte auf dem Dashboard angezeigt. Wenn Sie Parameter aus dem Widget entfernen und kein anderes Widget in diesem Dashboard den Parameter verwendet, wird die Parameter-Karte nicht mehr angezeigt.
- Legen Sie eine Aktualisierungszeit fest, wie oft Sie die Datenquelle abfragen. Die Standardaktualisierungszeit beträgt alle 5 Minuten. Je kürzer die Aktualisierungszeit ist, desto größer ist der Leistungseinfluss auf IBM QRadar. Die Aktualisierungszeit startet nach Abschluss der Abfrage.Wenn die Abfrage z. B. 3 Minuten dauert, startet die Aktualisierungszeit erst nach dem Ende ihrer 3-minütigen Ausführung.
- Wenn das Stammobjekt in der zurückgegebenen JSON nicht das Array ist, das Sie darstellen möchten, geben Sie eine Ergebniszuordnung ein, um zu definieren, welcher Schlüssel die relevanten Daten enthält, die Sie darstellen möchten. Weitere Informationen finden Sie unter Tipps zum Erstellen generischer API-Abfragen für Dashboarddiagramme.
- Optional: Wenn die zurückgegebene JSON eine Titelzuordnung enthält, setzen Sie Titel aus Ergebnismenge verwenden auf Am. Weitere Informationen finden Sie unter Tipps zum Erstellen generischer API-Abfragen für Dashboarddiagramme.
- Klicken Sie auf Abfrage ausführen.Wenn Sie das Widget zum ersten Mal erstellen, können Sie die Diagramme nicht konfigurieren, wenn keine Datenergebnisse zurückgegeben werden. Versuchen Sie, die Kriterien in den Feldern weniger streng zu gestalten, und führen Sie die Abfrage erneut aus.
- Erstellen Sie ein Dashboarddiagramm im Abschnitt Ansichten . Da Sie mit derselben Abfrage mehrere Ansichten und Diagramme erstellen können, geben Sie der Ansicht einen eindeutigen Namen. Standardmäßig werden Titel und Status des Diagramms in der Titelleiste angezeigt. Um sie auszublenden, können Sie auf das Symbol Weitere Optionen klicken und die Einstellungen auf Aus setzen.
- Wählen Sie einen Diagrammtyp und konfigurieren Sie die entsprechenden Eigenschaften. Anwendungsfälle zur Unterstützung bei der Entscheidung, welcher Diagrammtyp verwendet werden soll, finden Sie unter Widgetdiagrammtypen.
Diagrammtyp Anweisungen Balken Balkendiagramm erstellen Große Zahl Große-Zahlen-Diagramm erstellen Geografisch Geografisches Diagramm erstellen Kreis Kreisdiagramm erstellen Streudiagramm Streudiagramm erstellen Tabellarisch Tabellarisches Diagramm erstellen Zeitreihe Zeitreihendiagramm erstellen - Zeigen Sie eine Vorschau des Diagramms an und klicken Sie anschließend auf Speichern.Tipp: Die Beschriftungen für das Diagramm stammen aus den verwendeten Abfragen. Wenn sie in der Vorschau unleserlich sind, bearbeiten Sie die Beschriftungen im Abschnitt für die Ansicht.