Creazione di widget da un'origine dati API Generic

È possibile utilizzare l'API generica per creare widget che recuperano dati dalle API IBM® QRadar® e dalle applicazioni QRadar con API esposte.

Informazioni su questa attività

Le API restituiscono un array JSON (quando ci sono più risultati) o un oggetto JSON (quando c'è un solo risultato). Gli oggetti JSON restituiti vengono convertiti in un array JSON che contiene un elemento.

Procedura

  1. Fare clic su Configura dashboard.

    La schermata Configura dashboard visualizza una libreria di widget disponibili, con dettagli su ogni widget.

  2. Fare clic su Crea nuovo widget.
  3. Nella pagina Nuova voce Dashboard , inserire un nome e una descrizione per il widget.
  4. Selezionare API generica dall'elenco di origine dati nella sezione Query e inserire un endpoint API, come uno dei seguenti esempi:
    • /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 (immettere data in Associazione risultati).
      Nota: l' URL potrebbe cambiare da una versione all'altra di QDI.

    Per ulteriori informazioni, vedi Suggerimenti per la creazione di query API generiche per i grafici dashboard.

  5. Opzionale: Aggiungere parametri alla query delle API Generic.
    1. Inserire i parametri esistenti nel comunicato. Fare clic sull'icona Inserire parametro e quindi fare clic su Inserire per ogni parametro rilevante.
    2. Per modificare il valore predefinito del parametro, fare clic sull'icona Visualizza Parametri e fare clic su Salva dopo aver impostato il valore predefinito.
      Quando si modifica il valore predefinito per un parametro, si modifica il valore ovunque il parametro venga utilizzato nello spazio di lavoro, tranne che nei widget e nei dashboard espansi o bloccati. Se non si imposta il valore come valore predefinito, la modifica aggiornata si applica solo alla sessione corrente. Tuttavia, se si imposta il valore come predefinito, il valore di sessione corrente utilizza anche quel valore.

      Il parametro SYSTEM:username predefinito restituisce il nome utente dell'utente che ha eseguito l'accesso. I parametri di sistema sono letti solo e non è possibile modificare il valore predefinito.

    3. Per aggiungere un parametro allo spazio di lavoro, fare clic su Aggiungi, dare al parametro un nome e un valore predefinito, se necessario, quindi fare clic su Salva.

      Dopo aver aggiunto i parametri ad un widget su una dashboard per la prima volta, la scheda Parametri compare sulla dashboard. Se si rimuovono i parametri dal widget e nessun altro widget in quella dashboard utilizza il parametro, la scheda Parametri scompare.

  6. Scegli un tempo di aggiornamento per quanto spesso si esegue il sondaggio dell'origine dati. Il tempo di aggiornamento predefinito è ogni 5 minuti. Più breve è il tempo di aggiornamento, maggiore è l'impatto sulle prestazioni su IBM QRadar. Il tempo di aggiornamento inizia dopo che la query è completata.
    Ad esempio, se la query impiega 3 minutes minuti per completare, il tempo di aggiornamento inizia solo dopo la fine del 3 - minute.
  7. Se l'oggetto principale nel JSON restituito non è l'array che si desidera tracciare, inserire un Associazione dei risultati per definire quale chiave contiene i dati rilevanti che si desidera tracciare. Per ulteriori informazioni, consultare Suggerimenti per la creazione di query API generiche per i grafici dashboard.
  8. Facoltativo: Se il JSON restituito include una mappatura del titolo, impostare Utilizza titolo dalla serie di risultati a Su. Per ulteriori informazioni, consultare Suggerimenti per la creazione di query API generiche per i grafici dashboard.
  9. Fare clic su Esegui query.
    Quando si crea per la prima volta il widget, non è possibile configurare i grafici se non vengono restituiti risultati dati. Prova a rendere meno severi i criteri nei campi e eseguire di nuovo la query.
  10. Creare un grafico di dashboard nella sezione Viste .
    Poiché è possibile creare più viste e grafici dalla stessa query, dare alla vista un nome univoco. Per impostazione predefinita, vengono visualizzati il titolo e lo stato del grafico sulla barra del titolo; per nasconderli, fare clic sull'icona Più opzioni e passare le impostazioni a Off.
  11. Selezionare un tipo di grafico e configurare le relative proprietà. Per i casi di utilizzo che consentono di decidere quale tipo di grafico utilizzare, consultare Tipi di grafico widget.
    Tipo di grafico Istruzioni
    Barra Creazione di un grafico a barre
    Numero grande Creazione di un grafico con numeri grandi
    Geografico Creazione di un grafico geografico
    Torta Creazione di un grafico a torta
    A dispersione Creazione di un grafico a dispersione
    Tabellare Creazione di un grafico tabulare
    Serie temporale Creazione di un grafico di serie temporali
  12. Visualizzare in anteprima come appare il grafico e quindi fare clic su Salva.
    Suggerimento: Le etichette per il grafico provengono dalle query utilizzate. Se sono inintelligibili nell'anteprima, modificare le etichette nella sezione Vista .