Classes d’extension d’API sans correspondance

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 4 minutes de lecture
  • L’application de stockage CMDB CI Class Models ajoute ou met à jour des classes pour les API (interface de programmation d’applications) sans correspondance.

    L’application ajoute des modèles de classe qui étendent la hiérarchie des classes CMDB, y compris des descriptions de classe, des règles d’identification, des entrées d’identificateur et des relations dépendantes (le cas échéant). Vous pouvez utiliser les classes ajoutées comme n’importe quelle autre classe CMDB. Des applications telles que Patrons de détection et de mappage des services peuvent utiliser ces extensions de classe pour renseigner les CI et détecter diverses technologies et logiciels.

    Demander des applications dans l'App Store

    Visitez le site Web ServiceNow Store pour découvrir toutes les applications disponibles et pour obtenir des informations sur la procédure à suivre pour soumettre des demandes à la boutique. Pour obtenir des informations sur les notes de publication cumulatives pour toutes les applications publiées, consultez les ServiceNow Storenotes de publication relatives à l'historique des versions.

    API sans correspondance

    Les points de terminaison d’API qui ne sont pas suffisamment bien structurés pour renseigner les classes API [cmdb_ci_api] et Composant d’API [cmdb_ci_api_component] renseignent à la place la classe Point de terminaison d’API sans correspondance [cmdb_ci_unmatched_api_endpoint]. Les API sans correspondance sont généralement utilisées par les intégrations telles que les scanners de sécurité ou les outils d’observabilité.

    Classes

    Cette section répertorie les classes que l’application de stockage CMDB CI Class Models ajoute ou met à jour.

    CMDB CI Class Models : la version 1.49.0 ajoute la classe suivante pour les points de terminaison d’API sans correspondance. Pour obtenir la liste des classes CMDB dans un système de base, y compris celles que cette application de stockage est susceptible d’étendre, reportez-vous à Descriptions des tables CMDB.

    Classe Extensions Description
    Point de terminaison d’API sans correspondance

    [cmdb_ci_unmatched_api_endpoint]

    ID d'élément de configuration

    [cmdb_ci]

    API avec des points de terminaison non structurés qui ne peuvent pas renseigner les cmdb_ci_api ou les cmdb_ci_api_component.

    Attributs de classe

    CMDB CI Class Models : version 1.49.0 ajoute les attributs suivants à la classe Point de terminaison d’API sans correspondance [cmdb_ci_unmatched_api_endpoint].

    Tableau 1. Point de terminaison d’API sans correspondance [cmdb_ci_unmatched_api_endpoint]
    Attribut Type de données Description
    Méthode Chaîne Types de protocoles back-end de l’API. Exemples :
    • Lambda
    • HTTP
    • Application logique
    Protocole Chaîne Protocole de communication. Exemple : HTTP, HTTPS.
    URL Chaîne (1024) URL de la ressource appelée.
    ID Chaîne (1024) Identificateur unique du système source.
    Accessible sur Internet Booléen Booléen qui indique si le composant est accessible à partir de l’Internet public. Spécifiez 1 ou « true » si le composant est accessible.
    Autorisation Chaîne Type d’autorisation ou de méthode d’authentification. Exemple :
    • Élémentaire
    • Clé
    • OAuth
    • Aucun
    Types de données de demande Chaîne (255) Liste des types de données dans la demande. Exemples :
    • Cc
    • E-mail
    • Adresse
    Types de données de réponse Chaîne (255) Liste des types de données dans la réponse. Exemples :
    • Cc
    • E-mail
    • Adresse

    Structures des relations clés

    La classe CMDB Point de terminaison d’API sans correspondance [cmdb_ci_unmatched_api_endpoint] et la table non CMDB Point de terminaison d’API détecté [api_endpoint_discovered] sont destinées aux scénarios où des données d’API non structurées sont ingérées et doivent être traitées au-delà des capacités d’IntegrationHub-ETL.

    Point de terminaison d’API détecté [api_endpoint_discovered] peut servir de table intermédiaire pour les données brutes des classes API [cmdb_ci_api] et Composant d’API [cmdb_ci_api_component]. Les données d’API qui ne proviennent pas d’une source de données bien structurée ou qui ne peuvent pas avoir de règles d’identification standard appliquées peuvent d’abord remplir la table Point de terminaison d’API détecté [api_endpoint_discovered]. Vous pouvez ensuite utiliser une intégration définie par le client pour vous assurer que les données bien formées qui correspondent aux exigences de qualité et de condition pour l’API [cmdb_ci_api] et le composant d’API [cmdb_ci_api_component] remplissent la table la plus appropriée.

    Dans les cas où les données ne peuvent pas être analysées correctement ou sont structurées de manière inattendue, vous pouvez utiliser une intégration définie par le client pour remplir la table Point de terminaison d’API sans correspondance [cmdb_ci_unmatched_api_endpoint].

    Les données qui renseignent la table Point de terminaison d’API détecté [api_endpoint_discovered] sont purgées tous les 30 jours.

    Tableau 2. Point de terminaison d’API détecté [api_endpoint_discovered]
    Attribut Type de données Description
    Nom Chaîne (100) Nom du point de terminaison d’API.
    Méthode Chaîne Méthodes de REST API. Exemples :
    • GET
    • POST
    • DELETE
    URL Chaîne (1024) URL de la ressource appelée.
    Type Liste de choix Type d’API. Vous pouvez spécifier :
    • REST
    • SOAP
    • HTTP
    • gRPC (en anglais seulement)
    • GraphQL
    • Websocket
    Autorisation Chaîne Type d’autorisation ou de méthode d’authentification. Exemple :
    • Élémentaire
    • Clé
    • OAuth
    • Aucun
    Accessible sur Internet Booléen Booléen qui indique si le composant est accessible à partir de l’Internet public. Spécifiez 1 ou « true » si le composant est accessible.
    Types de données de demande Chaîne (255) Liste des types de données dans la demande. Exemples :
    • Cc
    • E-mail
    • Adresse
    Types de données de la réponse Chaîne (255) Liste des types de données dans la réponse. Exemples :
    • Cc
    • E-mail
    • Adresse
    En-têtes Chaîne (255) Liste de noms d’en-têtes séparés par des virgules.
    ID d'élément de configuration Référence Référence à un CI CMDB correspondant (composant d’API ou point de terminaison d’API sans correspondance).

    Tables non CMDB connexes

    La classe d’extension API sans correspondance utilise la table non CMDB Déploiement d’API [api_deployment] comme liste connexe :

    Tableau 3. Déploiement d’API [api_deployment]
    Attribut Type de données Description
    Nom Chaîne (100) Nom du déploiement d’API.
    API Référence Référence à l’API déployée (cmdb_ci_api).
    Point de terminaison d’API sans correspondance Référence Référence au point de terminaison d’API sans correspondance, si l’API ne correspond pas à une API existante (cmdb_ci_unmatched_api_endpoint).
    ID d'élément de configuration Référence Référence à l’élément de configuration. Cette option est généralement spécifiée manuellement comme référence, si vous savez sur quel CI l’API est déployée.