Utilisation du générateur de requêtes de l'API OData

Le générateur de requêtes de l'API OData crée des URL de requête qui exportent les données de configuration et de flux.
nfa1003
HID_ODataAPI_QueryBuilder
Le générateur de requêtes de l'API OData crée des URL de requête dans le cadre de l'exportation des données de configuration et d'interrogation.
3
Interface utilisateur du générateur de requêtes de l'API OData de NFA
L'image suivante illustre l'interface utilisateur du générateur de requêtes de l'API OData de NFA.
NFAQueryBuilderUI
Présentation de l'interface et des résultats du générateur de requêtes
Utilisez le champ
Query Expression
(Expression de requête) pour créer vos propres requêtes. L'application crée l'URL pour votre requête et l'affiche dans la section
OData URL
(URL OData). La section
Table - Results
(Table - Résultats) affiche les résultats de la requête. Vous pouvez trier la table des résultats dans l'ordre croissant ou décroissant. Vous pouvez sélectionner une colonne et personnaliser la table de résultats pour afficher uniquement les colonnes souhaitées. Vous pouvez également utiliser les flèches situées dans la partie inférieure de la section
Table - Results
(Table - Résultats) pour afficher d'autres résultats, le cas échéant. Cliquez sur l'icône du presse-papiers pour copier les résultats dans une autre application. Cliquez sur l'icône d'
exportation vers un fichier CSV pour exporter les résultats au format CSV. Cliquez sur le signe ? (Aide), pour afficher la documentation du générateur de requêtes de l'API OData de NFA.
Informations complémentaires
Création d'une requête de l'API OData
Pour extraire des ensembles de données personnalisés à partir de la source de données, utilisez le générateur de requêtes pour générer des requêtes d'API OData.
Les requêtes qui renvoient un ensembles de résultats volumineux peuvent avoir des conséquences négatives sur votre système. Il est recommandé d'affiner les requêtes pour qu'elles renvoient uniquement les résultats dont vous avez besoin.
La barre d'adresses du navigateur Web se met à jour pour afficher les jetons sélectionnés dans le champ Query Expression (Expression de requête). Pour continuer à modifier la requête ultérieurement, copiez cette URL et enregistrez-la.
Procédez comme suit :
  1. Cliquez sur le champ Query Expression (Expression de requête) pour lancer une requête.
  2. Sélectionnez l'option
    pour
    qui représente les données qui vous intéressent dans l'ensemble de données.
  3. Ajoutez les jetons
    sélectionner
    ,
    développer
    et
    filtrer
    pour définir les données de sortie.
  4. Ajoutez d'autres jetons pour affiner les résultats.
    Le générateur de requêtes de l'API OData crée l'URL OData.
  5. Exécution de la requête OData
    - Pour exécuter la requête dans la fenêtre de l'explorateur du générateur de requêtes, cliquez sur
    Run
    (Exécuter).
  6. Copie de l'URL OData dans le Presse-papiers
    - Après avoir créé la requête à l'aide des expressions disponibles, sélectionnez l'
    URL OData
    et cliquez sur
    Copy to clipboard
    (Copier dans le Presse-papiers) pour exécuter la requête à partir d'un navigateur Web, d'un outil REST ou d'une application personnalisée.
    Le rapport affiche le résultat de la requête dans une table.
Contrôles du générateur de requêtes de l'API OData de NFA
Le générateur de requêtes de l'API OData utilise des jetons qui représentent des éléments logiques dans la syntaxe de requête de l'API OData. Les jetons s'affichent lorsque vous cliquez sur le champ Query Expression (Expression de requête).Un jeton permet de sélectionner le type de propriété disponible pour l'entité sélectionnée. La sélection du jeton met à jour l'URL de la requête.
Utilisez les jetons suivants pour créer et exporter des URL de requête :
  • for
    Le jeton for (pour) détermine le type d'entité sur lequel la requête extrait des données. Il ne s'affiche qu'une seule fois dans chaque requête.
    La plupart des options de ce jeton incluent des sélections qui configurent un filtre automatique. Par exemple, lorsque vous sélectionnez interface dans le jeton, l'option développer le jeton s'affiche.Lorsque vous sélectionnez routeurs, l'option développer le jeton n'est pas disponible.
  • expand
    Le jeton expand (développer) indique les entités associées et les valeurs de flux qui doivent être représentées en ligne. Le service OData de CA NFA doit renvoyer le contenu spécifié et peut renvoyer des informations supplémentaires.
  • navigation
    Le jeton navigation est similaire à l'interface utilisateur de la console CA Network Flow Analysis. Le nom de la propriété de navigation est parfois suivi d'un segment de chemin /$count et éventuellement d'un ensemble entre parenthèses d'options de développement telles que le filtrage, le tri, la sélection, la pagination ou le développement des entités associées.
    Le générateur de requêtes prend actuellement en charge la navigation à deux niveaux maximum.
  • select
    Le jeton select (sélectionner) détermine les propriétés d'élément à inclure dans l'ensemble de données. L'ordre des propriétés n'est pas pris en charge dans les résultats.
  • filter
    Le jeton filter (filtrer) ajoute des filtres personnalisés basés sur des fonctions logiques à l'aide des opérations AND et OR. Indiquez si le filtre doit respecter la casse pour toutes les fonctions logiques.Lorsque OData évalue une expression de filtre, l'opérateur "De tout type" est utilisé pour déterminer si l'expression booléenne est vraie ou fausse pour une collection d'éléments. L'exemple suivant renvoie la valeur True :
     odata/api/interfaces?$filter=((ID eq 10) and (contains(RouterAddress,'10.0.0.19'))
     
  • custom parameter
    Le jeton custom parameter (paramètre personnalisé) ajoute des paramètres personnalisés dans la syntaxe OData à la requête.
  • sort
    Le jeton sort (trier) contrôle le tri de la sortie de la requête. Par exemple, la requête suivante trie l'entité d'interface par ID :
    /interfaces?$orderby=ID
  • limit (top)
    Le jeton limit (top) (limite (supérieure)) spécifie le nombre maximum de lignes ou de lignes développées dans la sortie de la requête.
    • Nombre maximum de lignes
      : nombre de lignes dans la table de résultats
    • Nombre de lignes à ignorer
      : nombre de lignes de début à omettre dans la sortie de la requête.
  • format
    Ce jeton détermine le format de l'ensemble de données renvoyé. L'API OData prend en charge le format HTML.
    HTML Table (Table HTML)
    Si la requête n'inclut pas ce jeton, le format de table HTML est utilisé par défaut.
    Le format de table HTML est uniquement pris en charge par le générateur de requêtes de l'API OData Les requêtes d'API OData directes prennent en charge les fichiers HTML et JSON.
Exportation des résultats de la requête
Vous pouvez télécharger le résultat de la requête au format CSV.
Exemple
: vous pouvez télécharger le rapport des propriétés sélectionnées des interfaces en procédant comme ci-dessous.
Procédez comme suit :
  1. Sélectionnez les options de requête suivantes dans le champ Query Expression (Expression de requête).
    1. for : interfaces
    2. sélectionner : AgentType,Description,Enabled,HarvesterAddress,ID,IfIndex
  2. Sélectionnez
    Run
    (Exécuter ) pour exécuter la requête.
  3. Cliquez sur le bouton NFAQueryBuilderExportCSV pour exporter les résultats de la requête au format CSV.
Le rapport est enregistré au format CSV dans votre répertoire de téléchargement par défaut.