API-Erweiterungsklassen ohne Übereinstimmung

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 3 Minuten Lesedauer

    • Die Store-App CMDB CI Class Models fügt Klassen für nicht abgeglichene APIs (Anwendungsprogrammierschnittstelle) hinzu oder aktualisiert sie.

    Die App fügt Klassenmodelle hinzu, die die CMDB-Klassenhierarchie erweitern, einschließlich Klassenbeschreibungen, Identifizierungsregeln, Bezeichnereinträgen und abhängigen Beziehungen (falls zutreffend). Sie können die hinzugefügten Klassen als jede andere CMDB-Klasse verwenden. Anwendungen wie Muster für Discovery und Service-Mapping können diese Klassenerweiterungen verwenden, um CIs auszufüllen und verschiedene Technologien und Software zu erkennen.

    Apps im Store anfordern

    Besuchen Sie die ServiceNow Store-Website, um alle verfügbaren Apps anzuzeigen und Informationen zum Senden von Anforderungen an den Store zu erhalten. Kumulative Informationen zum Release für alle veröffentlichten Apps finden Sie in den Release-Hinweisen zum ServiceNow Store-Versionsverlauf.

    Nicht abgeglichene APIs

    API-Endpunkte, die nicht gut genug strukturiert sind, um die Klassen „API“ [cmdb_ci_api] und „API-Komponente“ [cmdb_ci_api_component] auszufüllen, füllen stattdessen die Klasse „Nicht abgeglichener API-Endpunkt“ [cmdb_ci_unmatched_api_endpoint]. Nicht abgeglichene APIs werden normalerweise von Integrationen wie Sicherheitsscannern oder Observability-Tools verwendet.

    Klassen

    In diesem Abschnitt werden die Klassen aufgelistet, die die Store-App CMDB CI Class Models hinzufügt oder aktualisiert.

    CMDB CI Class Models: Release 1.49.0 fügt die folgende Klasse für nicht abgeglichene API-Endpunkte hinzu. Eine Liste der CMDB-Klassen in einem Basissystem, einschließlich der Klassen, die diese Store-App möglicherweise erweitert, finden Sie unter CMDB-Tabellenbeschreibungen.

    Klasse Erweitert Beschreibung
    Nicht abgeglichener API-Endpunkt

    [cmdb_ci_unmatched_api_endpoint]

    		 Konfigurationselement

    [cmdb_ci]

    		 APIs mit unstrukturierten Endpunkten, die cmdb_ci_api oder cmdb_ci_api_component nicht ausfüllen können.

    Klassenattribute

    CMDB CI Class Models: Release 1.49.0 fügt der Klasse „Nicht abgeglichener API-Endpunkt“ [cmdb_ci_unmatched_api_endpoint] die folgenden Attribute hinzu.

    Tabelle : 1. Nicht abgeglichener API-Endpunkt [cmdb_ci_unmatched_api_endpoint]
    Attribut Datentyp Beschreibung
    Methode Zeichenfolge Back-End-Protokolltypen der API. Beispiele:
    • Lambda
    • HTTP
    • Logik-App
    Protokoll Zeichenfolge Kommunikationsprotokoll. Beispiel: HTTP, HTTPS.
    URL Zeichenfolge (1024) URL der aufgerufenen Ressource.
    ID Zeichenfolge (1024) Eindeutiger Bezeichner aus dem Quellsystem.
    Mit Internetzugriff Boolean Boolescher Wert, der angibt, ob die Komponente über das öffentliche Internet erreichbar ist. Geben Sie 1 oder „wahr“ an, wenn die Komponente erreichbar ist.
    Autorisierung Zeichenfolge Typ der Autorisierung oder Authentifizierungsmethode. Beispiel:
    • Standard
    • Schlüssel
    • OAuth
    • Keine
    Anforderungsdatentypen Zeichenfolge (255) Liste der Datentypen in der Anforderung. Beispiele:
    • CC
    • E-Mail
    • Adresse
    Antwortdatentypen Zeichenfolge (255) Liste der Datentypen in der Antwort. Beispiele:
    • CC
    • E-Mail
    • Adresse

    Wichtige Beziehungsstrukturen

    Die CMDB-Klasse „Nicht abgeglichener API-Endpunkt“ [cmdb_ci_unmatched_api_endpoint] und die Nicht-CMDB-Tabelle „Erkannter API-Endpunkt“ [api_endpoint_discovered] sind für Szenarien gedacht, in denen unstrukturierte API-Daten erfasst werden und über die Fähigkeiten von IntegrationHub-ETL hinaus verarbeitet werden müssen.

    Der erkannte API-Endpunkt [api_endpoint_discovered] kann als Bereitstellungstabelle für Rohdaten für die Klassen API [cmdb_ci_api] und API-Komponente [cmdb_ci_api_component] dienen. API-Daten, die nicht aus einer gut strukturierten Datenquelle stammen oder auf die keine Standardidentifizierungsregeln angewendet werden können, können zuerst die Tabelle „API-Endpunkt erkannt“ [api_endpoint_discovered] füllen. Sie können dann eine benutzerdefinierte Integration verwenden, um sicherzustellen, dass ordnungsgemäß formatierte Daten, die den Qualitäts- und Bedingungsanforderungen für API [cmdb_ci_api] und API-Komponente [cmdb_ci_api_component] entsprechen, die am besten geeignete Tabelle füllen.

    In Fällen, in denen die Daten nicht korrekt analysiert werden können oder unerwartet strukturiert sind, können Sie stattdessen eine benutzerdefinierte Integration verwenden, um die Tabelle „Nicht abgeglichener API-Endpunkt“ [cmdb_ci_unmatched_api_endpoint] auszufüllen.

    Daten, die die Tabelle „API-Endpunkt erkannt“ [api_endpoint_discovered] ausfüllen, werden alle 30 Tage gelöscht.

    Tabelle : 2. API-Endpunkt erkannt [api_endpoint_discovered]
    Attribut Datentyp Beschreibung
    Name Zeichenfolge (100) Name des API-Endpunkts.
    Methode Zeichenfolge REST API-Methoden. Beispiele:
    • GET
    • POST
    • LÖSCHEN
    URL Zeichenfolge (1024) URL der aufgerufenen Ressource.
    Typ Auswahlliste Typ der API. Sie können Folgendes angeben:
    • REST
    • SOAP
    • HTTP
    • gRPC
    • GraphQL
    • Websocket
    Autorisierung Zeichenfolge Typ der Autorisierung oder Authentifizierungsmethode. Beispiel:
    • Standard
    • Schlüssel
    • OAuth
    • Keine
    Mit Internetzugriff Boolean Boolescher Wert, der angibt, ob die Komponente über das öffentliche Internet erreichbar ist. Geben Sie 1 oder „wahr“ an, wenn die Komponente erreichbar ist.
    Anforderungsdatentypen Zeichenfolge (255) Liste der Datentypen in der Anforderung. Beispiele:
    • CC
    • E-Mail
    • Adresse
    Antwortdatentypen Zeichenfolge (255) Liste der Datentypen in der Antwort. Beispiele:
    • CC
    • E-Mail
    • Adresse
    Header Zeichenfolge (255) Kommagetrennte Liste mit Kopfzeilennamen.
    Konfigurationselement Referenz Verweis auf ein übereinstimmendes CMDB-CI (API-Komponente oder nicht abgeglichener API-Endpunkt).

    Zugehörige Nicht-CMDB-Tabellen

    Die API-Erweiterungsklasse „Nicht abgeglichen“ verwendet die Nicht-CMDB-Tabelle „API-Bereitstellung“ [api_deployment] als zugehörige Liste:

    Tabelle : 3. API-Bereitstellung [api_deployment]
    Attribut Datentyp Beschreibung
    Name Zeichenfolge (100) Name der API-Bereitstellung.
    API Referenz Verweis auf die bereitgestellte API (cmdb_ci_api).
    Nicht abgeglichener API-Endpunkt Referenz Verweis auf den nicht abgeglichenen API-Endpunkt, wenn die API nicht mit einer vorhandenen API (cmdb_ci_unmatched_api_endpoint) übereinstimmt.
    Konfigurationselement Referenz Verweis auf das Konfigurationselement. Dies wird normalerweise manuell als Referenz angegeben, wenn Sie wissen, für welches CI die API bereitgestellt wird.