CMDBQueryBuilderAPI : global

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 2 minutes de lecture

    • CMDBQueryBuilderAPI fournit des méthodes pour récupérer les détails d’exécution de requête enregistrés dans le générateur de requêtes dans des scripts côté serveur.

    Pour accéder à cette API, vous devez activer le module d’extension Configuration Management (CMDB) (com.snc.cmdb).

    Pour plus d’informations sur le générateur de requêtes CMBD, consultez Interrogation de la CMDB.

    CMDBQueryBuilderAPI : getSavedQueryExecutionDetails(String savedQueryName, booléen executeQuery, Number timeout)

    Renvoie les détails de l’exécution d’une requête enregistrée dans le générateur de requêtes spécifiée Base de données de gestion des configurations (CMDB) .

    Vous pouvez éventuellement spécifier si la requête doit être exécutée ou non, afin de renvoyer ses détails d’exécution de requête les plus récents. Vous pouvez également remplacer la limite de délai d’expiration par défaut pour l’exécution de la requête.

    En cas de problème de délai ou de mémoire lors de l’exécution de la requête, vous pouvez affiner la taille du lot de requêtes pour aider à atténuer ces problèmes. Pour plus d’informations, consultez Taille du lot pour les requêtes enregistrées dans le générateur de requêtes.

    Tableau 1. Paramètres
    Nom Type Description
    Executequery Booléen Facultatif. Marqueur indiquant si la requête spécifiée doit être exécutée ou non.

    Valeurs valides :

    • true : exécute la requête spécifiée et renvoie ses détails d’exécution.
    • false : n’exécute pas la requête spécifiée. Renvoyer les détails d’exécution les plus récents de la requête.

    Valeur par défaut : false
    savedQueryName Chaîne Nom de la requête enregistrée du générateur de requêtes CMDB pour laquelle renvoyer les détails de l’exécution de la requête.
    timeout Numéro Facultatif. Valeur entière qui remplace la limite de délai d’exécution de la requête par défaut de cinq minutes.

    Unité : Secondes

    Valeur par défaut : cinq minutes
    Tableau 2. Renvoie
    Type Description
    Erreur Code et message d’erreur. Renvoyé lorsque l’exécution de la requête échoue ou que la requête spécifiée est introuvable.

    Exemples d’erreurs :

    • {"error » : « QUERY_EXECUTION_NOT_FOUND », « message » : « Détails de l’exécution de la requête introuvables. Veuillez exécuter la requête."}
    • {"error » : « QUERY_NOT_FOUND », « message » : « Requête enregistrée donnée introuvable. Assurez-vous de transmettre le nom d’une requête enregistrée."}
    • {"error » : « QUERY_EXECUTION_FAILED », « message » : « Échec de l’exécution de la requête. Veuillez utiliser une requête valide."}
    query_id ID d’exécution de requête enregistrée (sys_id). Obtenu à partir de la table État de la requête [qb_query_status].
    table_name Nom de la table qui contient les détails de la requête d’exécution.
    statut État de l’exécution de la requête.
    • TERMINÉ : l’exécution est terminée.
    • FAILED : une erreur s’est produite lors de l’exécution de la requête.
    • TIME_OUT : l’exécution de la requête a expiré.
    • MAX_LIMIT : nombre maximal de résultats de retour atteint.

    Cet exemple montre comment appeler la méthode getSavedQueryExecutionDetails().

    SNC.CMDBQueryBuilderAPI.getSavedQueryExecutionDetails('Test', true);

    Sortie :

    {"query_id":"024fd53a7773330033b5270bba106141",
"table_name":"u_cmdb_qb_result_598918aacb4dbf3f1a8dcf03fce6a5d57151a4e2",
"status":COMPLETE}

    Cet exemple montre comment appeler la méthode getSavedQueryExecutionDetails() et remplacer la valeur de délai d’exécution de requête par défaut à 10 minutes.

    SNC.CMDBQueryBuilderAPI.getSavedQueryExecutionDetails('Test', true, 600);

    Sortie :

    {"query_id":"024fd53a7773330033b5270bba106141",
"table_name":"u_cmdb_qb_result_598918aacb4dbf3f1a8dcf03fce6a5d57151a4e2",
"status":COMPLETE}