Création de widgets à partir d'une source de données de l'API générique
Vous pouvez utiliser l'API générique pour créer des widgets qui extraient des données des API IBM® QRadar® et des applications QRadar avec des API exposées.
A propos de cette tâche
Les API renvoient un tableau JSON (lorsqu'il y a plusieurs résultats) ou un objet JSON (alors qu'il n'y a qu'un seul résultat). Les objets JSON renvoyés sont convertis en un tableau JSON qui contient un élément.
Procédure
- Cliquez sur Configurer tableau de bord.
L'écran Configurer le tableau de bord affiche la bibliothèque de widgets disponibles, avec des informations sur chaque widget.
- Cliquez sur Créer un widget.
- Sur la page Nouvel élément de tableau de bord , entrez un nom et une description pour le widget.
- Sélectionnez API générique dans la liste des sources de données dans la section Requête et entrez un noeud final d'API, comme l'un des exemples suivants:
/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
(entrez data dans Mappage de résultats).Remarque : l' URL peut changer d'une version à l'autre de QDI.
Pour plus d'informations, voir Conseils de création de requêtes d'API génériques pour les graphiques de tableau de bord.
- Facultatif: Ajoutez des paramètres à la requête d'API générique.
- Insérer les paramètres existants dans l'instruction. Cliquez sur l'icône Insérer un paramètre, puis sur Insérer pour chaque paramètre pertinent.
- Pour modifier la valeur par défaut du paramètre, cliquez sur l'icône Paramètres de vue , puis sur Sauvegarder après avoir défini la valeur par défaut.Lorsque vous modifiez la valeur par défaut d'un paramètre, vous modifiez la valeur partout où le paramètre est utilisé dans votre espace de travail, sauf dans les tableaux de bord et les widgets développés ou épinglés. Si vous ne définissez pas la valeur comme valeur par défaut, la modification mise à jour s'applique uniquement à la session en cours. Toutefois, si vous définissez la valeur comme valeur par défaut, la valeur de la session actuelle utilise également cette valeur.
Le paramètre prédéfini SYSTEM:username renvoie le nom d'utilisateur de l'utilisateur connecté. Les paramètres du système sont en lecture seule et vous ne pouvez pas modifier la valeur par défaut.
- Pour ajouter un paramètre à votre espace de travail, cliquez sur Ajouter, donnez au paramètre un nom et une valeur par défaut, si nécessaire, puis cliquez sur Sauvegarder.
Une fois que vous avez ajouté des paramètres à un widget sur un tableau de bord pour la première fois, la carte Paramètres apparaît sur le tableau de bord. Si vous supprimez des paramètres du widget et qu'aucun autre widget dans ce tableau de bord n'utilise le paramètre, la carte Paramètres disparaît.
- Choisissez un temps d'actualisation pour la fréquence à laquelle vous interrogez la source de données. L'heure d'actualisation par défaut est toutes les 5 minutes. Plus le temps d'actualisation est court, plus l'impact sur les performances sur IBM QRadarest important. Le temps d'actualisation commence après que la requête soit terminée.Par exemple, si la requête prend 3 minutes pour se terminer, le temps d'actualisation commence seulement après que les 3 minutes se soient écoulées.
- Si l'objet racine dans le fichier JSON renvoyé n'est pas le tableau que vous souhaitez tracer, entrez un Mappage des résultats pour définir la clé contenant les données pertinentes à tracer. Pour plus d'informations, voir Conseils pour la création de requêtes d'API générique pour les graphiques de tableau de bord.
- Facultatif: Si le JSON renvoyé inclut un mappage de titre, définissez Utiliser le titre de l'ensemble de résultats sur Sur. Pour plus d'informations, voir Conseils pour la création de requêtes d'API générique pour les graphiques de tableau de bord.
- Cliquez sur Exécuter la requête.Lorsque vous créez le widget pour la première fois, vous ne pouvez pas configurer les graphiques si aucun résultat de données n'est renvoyé. Essayez de rendre les critères des zones moins stricts et exécutez à nouveau la requête.
- Créez un graphique de tableau de bord dans la section Vues . Comme vous pouvez créer plusieurs vues et graphiques à partir de la même requête, donnez un nom unique à la vue. Par défaut, le titre et le statut du graphique sur la barre de titre sont affichés ; pour les masquer, cliquez sur l'icône Autres options et remplacez les paramètres par Désactivé.
- Sélectionnez un type de graphique et configurez les propriétés correspondantes. Pour connaître les cas d'utilisation qui vous aideront à déterminer le type de graphique à utiliser, voir Types de graphique de widget.
Type de graphique Instructions Barre Création d'un diagramme à barres Graphique de grands nombres Création d'un tableau de grands nombres Informations géographiques Création d'un graphique géographique Graphique circulaire Création d'un graphique circulaire Nuage de points Création d'un graphique à nuage de points Tableau Création d'un graphique tabulaire Séries temporelles Création d'un diagramme de série temporelle - Prévisualisez le mode de présentation du graphique, puis cliquez sur Sauvegarder.Conseil : les libellés du graphique proviennent des requêtes utilisées. S'ils sont inintelligibles dans l'aperçu, éditez-les dans la section Afficher.