API-Erweiterungsklassen

Freigeben Version: Zurich

Aktualisiert 7. August 2025

8 Minuten Lesedauer

Die CMDB CI-Klassenmodelle ServiceNow Store App fügt Klassen für APIs (Anwendungsprogrammierschnittstelle) hinzu oder aktualisiert sie.

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

Sie finden vollständige Versionshinweise für alle CMDB CI-Klassenmodelle Releases um: https://www.servicenow.com/docs/bundle/store-release-notes/page/release-notes/store/it-operations-management/store-rn-itom-cmdb-class-models.html?emcs_t=S2h8ZW1haWx8Ym9hcmRfc3Vic2NyaXB0aW9ufE1FMlVTSFREVDc3S0hTfDMzNDcxMjV8U1VCU0NSSVBUSU9OU3xoSw

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.

APIs

APIs sind eine Reihe von Definitionen und Protokollen, die es Computerprogrammen ermöglichen, miteinander zu kommunizieren, sodass Sie Anwendungssoftware erstellen oder integrieren können. APIs verwenden normalerweise webbasierte Technologie, um mit anderen APIs zu kommunizieren. APIs werden im Allgemeinen verwendet, um programmgesteuert Aufträge oder Aufgaben auszuführen oder anzuzeigen, zu importieren, zu exportieren, zu löschen, oder ändern Sie Daten.

Die in diesem Release hinzugefügten Klassen erweitern CMDB Datenmodell und bieten eine Grundlage für die Darstellung von API-CI-Klassen. Mit dieser Grundlage können Sie Folgendes tun:

Verschaffen Sie sich einen besseren Einblick in Ihre APIs.
Identifizieren Sie Sicherheitsprobleme und Schwachstellen im Zusammenhang mit einem API-Endpunkt.

Klassen

In diesem Abschnitt werden die Klassen aufgeführt, die die CMDB CI-Klassenmodelle Store-App fügt hinzu oder aktualisiert sie. Weitere Informationen finden Sie unter Community-artikel mit dem Titel „Neues Datenmodell in CMDB für APIs“ .

CMDB CI-Klassenmodelle: Die folgenden Klassen für API sind verfügbar. Für die Liste der Klassen in Basissystem, Einschließlich Klassen, die diese App erweitern könnte, siehe CMDB-Tabellenbeschreibungen.


Klasse	Erweitert	Beschreibung
API [cmdb_ci_api]	Konfigurationselement [cmdb_ci]	APIs, die es zwei Computerprogrammen ermöglichen, miteinander zu kommunizieren, normalerweise mithilfe webbasierter Technologien. Beispiel: ChatAPI (https://[apiID].execute-api.use-east-2.amazonaws.com).
API-Komponente [cmdb_ci_api_component]	Konfigurationselement [cmdb_ci]	Wiederverwendbare Objekte im Zusammenhang mit Ihrer API-Definition, die die Funktionalität oder den Datenaustausch erleichtern. Zugehörige Liste der API-Header. Beispiel: GET https://[instance].service-now.com/api/now/table/{tablename}.
API-Front-End [cmdb_ci_api_Frontend]	API-Komponente [cmdb_ci_api_component]	Der Teil einer API, über den ein Client oder Anwender interagiert oder Anforderungen stellt. Beispiel: GET https://[apiID].execute-api.us-east-2.amazonaws.com/{proxy+}.
API-Back-End [cmdb_ci_api_Backend]	API-Komponente [cmdb_ci_api_component]	Der Teil einer API, der Anforderungen durch Interaktion mit Back-End-Services wie Servern erfüllt. Beispiel: Lambda:Chat-API-Proxy.
API-Gateway [cmdb_ci_api_Gateway]	Anwendung [cmdb_ci_appl]	API-Infrastruktur, die Client-API-Anforderungen zentralisiert und Back-End-Prozesse und -Services verwaltet. Beispiel: Kong-Gateway.
Verwaltete API [cmdb_ci_Managed_api]	Konfigurationselement [cmdb_ci_api]	API von einem Gateway oder Verwaltungsservice erkannt. Sie können eine Abhängigkeit von einem Gateway für APIs in dieser Klasse erzwingen.

Klassenattribute

CMDB CI-Klassenmodelle: Release 1.49.0 fügt den jeweiligen Klassen die folgenden Attribute hinzu.

Tabelle : 1. API [cmdb_ci_api]
Attribut	Datentyp	Beschreibung
Basis-URL	Zeichenfolge (1024)	Basisadresse, von der alle API-Komponenten erweitert werden.
ID	Zeichenfolge (1024)	Eindeutiger Bezeichner aus dem Quellsystem.
Typ	Auswahlliste	Typ der API. Sie können Folgendes angeben: REST SOAP HTTP gRPC GraphQL Websocket
Version	Numerisch	Version der API.
Spezifikationsstandort	URL	URL zum Speicherort der API-Spezifikation. Beispiel: OpenAPI-Spezifikationsdefinition.
Speicherort der technischen Spezifikation	Zeichenfolge	Speicherort des Repositorys für technische Spezifikationen für eine API. Beispiel: GitHub-Repository mit dem bereitgestellten API-Code.
Speicherort der Designspezifikation	Zeichenfolge	URL zum Speicherort des API-Designs oder der Dokumentation. Beispiel: URL der SwaggerHub-API-Designspezifikation.

Die API-Klasse [cmdb_ci_api] unterstützt die Zuordnung von Tags und Bezeichnungen zur Tabelle „Schlüsselwert“ [cmdb_key_value], um die Schlüssel-Wert-Speicherung für API-Metadaten zu aktivieren.

Tabelle : 2. API-Komponente [cmdb_ci_api_component]
Attribut	Datentyp	Beschreibung
Methode	Zeichenfolge	REST API-Methoden. Beispiele: GET VERÖFFENTLICHEN LÖSCHEN
Protokoll	Zeichenfolge	Kommunikationsprotokoll. Beispiel: HTTP, HTTPS.
Host	Zeichenfolge (100)	System, das die API hostet.
Pfad	Zeichenfolge (1024)	Spezifische Route, der die API folgt.
Port	Zeichenfolge	Kommunikationsport. Beispiel: 80, 443 usw.
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 Autorisierungs- 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

Die Klasse „API-Komponente“ [cmdb_ci_api_component] unterstützt die Zuordnung von Tags und Bezeichnungen zur Tabelle „Schlüsselwert“ [cmdb_key_value], um die Speicherung von Schlüssel-Wert für API-Komponentenmetadaten zu aktivieren.

Tabelle : 3. API-Frontend [cmdb_ci_api_Frontend]
Attribut	Datentyp	Beschreibung
Übergeordnete ID	Verweis auf [cmdb_ci_api_Frontend]	Verweis auf eine übergeordnete API-Komponente.

Tabelle : 4. API-Back-End [cmdb_ci_api_Backend]
Attribut	Datentyp	Beschreibung
Typ	Zeichenfolge	Back-End-Protokolltypen der API. Beispiele: Lambda HTTP Logik-App

Tabelle : 5. API-Gateway [cmdb_ci_api_Gateway]
Attribut	Datentyp	Beschreibung
ID	Zeichenfolge (255)	Eindeutiger Bezeichner aus dem Quellsystem.

Die API-Gateway-Klasse [cmdb_ci_api_Gateway] unterstützt die Zuordnung von Tags und Bezeichnungen zur Tabelle „Schlüsselwert“ [cmdb_key_value]. Die Zuordnung ermöglicht die Speicherung von Schlüssel-Wert-Werten für API-Gateway-Metadaten.

Die folgenden Markerklassen sind für API-Gateways verfügbar. Diese Klassen erben alle Attribute von der übergeordneten Klasse des API-Gateways [cmdb_ci_api_Gateway].

AnyPoint-API-Gateway [cmdb_ci_api_Gateway_anypoint] (bereitgestellt von MuleSoft)
Tyk-API-Gateway [cmdb_ci_api_Gateway_tyk] (bereitgestellt von Tyk)
Boomi-API-Gateway [cmdb_ci_api_Gateway_boomi] (bereitgestellt von Boomi)

Die Markerklassen folgen der vorhandenen Klassenstruktur und erfordern keine Änderungen an Engine für Identifizierung und Abgleich (IRE) Regeln.

Hinweis:

Die Klasse „verwaltete API“ [cmdb_ci_Managed_api] ist spezifisch für APIs, die von Gateways und anderen verwalteten Services erkannt wurden, und führt keine neuen Attribute ein.

In API-Gateways und Entwicklerportalen ist ein API-Produktpaket eine Sammlung von einer oder mehreren APIs, die von Entwicklern und Anwendungen verwendet werden sollen. Einige Plattformen verwenden den Begriff nur für ein API-Produkt.

Tabelle : 6. API-Produktpaket [cmdb_ci_api_Product_Bundle]
Attribut	Datentyp	Beschreibung
ID	Zeichenfolge (255)	Eindeutiger Bezeichner des API-Produktpakets.
Erkannter Genehmigungstyp	Zeichenfolge	Typ der Anforderungsgenehmigung, wie im Quellsystem erkannt.
Erkannter Zugriffstyp	Zeichenfolge	Greifen Sie auf die vom Quellsystem erkannte Konfiguration zu. Beispiel: Öffentlich oder intern.
Erstellungsdatum	Datum/Uhrzeit	Datum und Uhrzeit der anfänglichen Erkennung oder Aufzeichnung des API-Produktpakets.
Datum der letzten Änderung	Datum/Uhrzeit	Datum und Uhrzeit der letzten Aktualisierung des API-Produktpakets.
Erkannter Status	Zeichenfolge	Aktueller Status des Produktpakets, wie von der Quelle gemeldet. Zum Beispiel veröffentlicht oder veraltet.

Um auf ein oder mehrere API-Produktpakete zuzugreifen, kann sich ein Entwickler für ein API-Verbraucherabonnement in einem Entwicklerportal registrieren. Das Abonnement registriert sich bei einem oder mehreren Paketen und stellt einen Schlüssel für den Zugriff auf die APIs in den Paketen bereit.

Tabelle : 7. API-Verbraucherabonnement [cmdb_ci_api_Consumer_Subscription]
Attribut	Datentyp	Beschreibung
Erkannter Umfang	Zeichenfolge	Umfang des Zugriffs, wie vom Quellsystem erkannt. Zum Beispiel alle APIs oder bestimmte APIs.
API-Verbraucher	Referenz	Verweis auf den API-Verbraucher-Datensatz. Beispiel: cmdb_ci_api_Consumer.
ID	Zeichenfolge (255)	Eindeutiger Bezeichner des API-Verbraucher-Abonnements.
Erkannter Status	Zeichenfolge	Abonnementstatus wie vom Quellsystem erkannt. Zum Beispiel aktiv oder inaktiv.
Erstellungsdatum	Datum/Uhrzeit	Datum und Uhrzeit der Erstellung des API-Verbraucherabonnements im Quellsystem.
Datum der letzten Änderung	Datum/Uhrzeit	Datum und Uhrzeit der letzten Aktualisierung des API-Verbraucherabonnements.

Die WebACL-Klasse [cmdb_ci_Web_acl] stellt ACLs für CloudFront, API-Gateway-REST-APIs, Anwendungslastausgleichsmodule, AppSync GraphQL APIs, Cognito-Anwenderpools, App Runner-Services dar. von AWS verifizierter Zugriff und Azure Front Door Application Gateway.

Wichtige Beziehungsstrukturen

Es gibt eine Reihe von Schlüsselbeziehungen, die für API- und Kong-Klassen definiert werden müssen.

Tabelle : 8. API-Beziehungen
Übergeordnete Klasse	Beziehung	Untergeordnete Klasse	Beziehungstyp
API [cmdb_ci_api]	Verwendet::Verwendet von	API-Komponente [cmdb_ci_api_component]	Vorgeschlagen
API-Gateway [cmdb_ci_api_Gateway]	Stellt Bereit::Bereitgestellt Von	Verwaltete API [cmdb_ci_Managed_api]	Abhängig
API-Front-End [cmdb_ci_api_Frontend]	Endpunkt verwenden an::Endpunkt verwenden von	API-Back-End [cmdb_ci_api_Backend]	Vorgeschlagen
API-Back-End [cmdb_ci_api_Backend]	Verwendet::Verwendet Von	Kong-Lastenausgleichsmodul [cmdb_ci_kong_lb]	Vorgeschlagen
API-Gateway [cmdb_ci_api_Gateway]	Stellt Bereit::Bereitgestellt Von	API-Produktpaket [cmdb_ci_api_Product_Bundle]	Abhängig
API-Gateway [cmdb_ci_api_Gateway]	Stellt Bereit::Bereitgestellt Von	API-Verbraucherabonnement [cmdb_ci_api_Consumer_Subscription]	Abhängig
API-Produktpaket	Enthält::Enthalten in	API [cmdb_ci_api]	Vorgeschlagen
API-Produktpaket	Verwendet von::Verwendet	API-Verbraucherabonnement [cmdb_ci_api_Consumer_Subscription]	Vorgeschlagen

Zugehörige nicht-CMDB-Tabellen

CMDB CI-Klassenmodelle v 1.49.0 führt die folgenden nicht-CMDB-Tabellen als zugehörige Listen für die folgenden API-Erweiterungsklassen ein:

Zugehörige API-Liste

Tabelle : 9. 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.

Hinweis:

Die Tabelle „API-Bereitstellung nicht-CMDB“ bezieht sich sowohl auf die API-Klassen [cmdb_ci_api] als auch auf die nicht abgeglichenen API-Endpunkte [cmdb_ci_unmatched_api_Endpoint].

Zugehörige Liste der API-Komponente

Tabelle : 10. API-Header [api_Header]
Attribut	Datentyp	Beschreibung
Name	Zeichenfolge (100)	Name des API-Headers.
API-Komponente	Referenz	Verweis auf die Komponente, in der der API-Header definiert ist (cmdb_ci_api_component).
Nicht abgeglichener API-Endpunkt	Referenz	Verweis auf die nicht abgeglichene API, wenn der Endpunkt nicht mit einer vorhandenen API oder Komponente abgeglichen werden kann (cmdb_ci_unmatched_endpoint).

Zugehörige API-Gateway-Listen

Tabelle : 11. API-Verbraucher [api_Consumer]
Attribut	Datentyp	Beschreibung
Anwendername	Zeichenfolge (100)	Name des API-Verbrauchers. Hinweis: Die Verbraucher Das Feld in der Tabelle „api_Policy“ ist ein Referenzfeld. Um den Anwendernamen in anzuzeigen Anwendername Feld in der API-Richtlinienliste müssen Sie festlegen displayAttribut von Anwendername Bis `Wahr` . Wenn das Attribut nicht auf festgelegt ist `Wahr` , Dann zeigt die Liste stattdessen die SYS-ID an.
ID	Zeichenfolge (255)	Eindeutiger Bezeichner aus dem Quellsystem.
Anwenderdefinierte ID	Zeichenfolge (100)	Alternativer Anzeigename des Anwenders.
API-Gateway	Referenz	Verweis auf das Gateway, in dem der Verbraucher definiert ist (cmdb_ci_api_Gateway).
Typ des API-Verbrauchers	Auswahlliste	API-Anwendertyp (user_type). Sie können Folgendes angeben: Intern Extern Unbekannt
Erkannter Status	Zeichenfolge	Stellt den aktuellen Status des API-Verbraucherkontos dar.
Anbieter	Zeichenfolge	Name des Identitätsverwaltungsanbieters, der für die Authentifizierung des API-Verbrauchers verantwortlich ist.
E-Mail	Zeichenfolge	E-Mail-Adresse des API-Verbrauchers.
Registrierungsdatum	Datum/Uhrzeit	Datum der Registrierung des Verbrauchers bei der bereitstellenden Plattform.

Tabelle : 12. API-Verbraucherzugriff [api_Consumer_Access]
Attribut	Datentyp	Beschreibung
API-Verbraucher	Referenz	Verweis auf den API-Verbraucher-Datensatz. Beispiel: cmdb_ci_api_Consumer.
API	Referenz	Verweis auf die API [cmdb_ci_api], auf die der Verbraucher Zugriff anfordert.
Auth-Methode	Zeichenfolge	Authentifizierungsmethode, die vom API-Verbraucher für den Zugriff auf die API verwendet wird. Beispiel: API-Schlüssel oder OAuth.
Status	Auswahl	Gibt an, ob der Zugriff derzeit aktiv oder inaktiv ist.
Zuletzt verwendet	Datum/Uhrzeit	Datum und Uhrzeit des letzten Zugriffs des API-Verbrauchers auf die API.
Gültig bis	Datum/Uhrzeit	Ablaufdatum des Zugriffs des Verbrauchers auf die API.

Tabelle : 13. API-Richtlinie [api_Policy]
Attribut	Datentyp	Beschreibung
Name	Zeichenfolge (100)	Name der API-Richtlinie.
ID	Zeichenfolge (255)	Eindeutiger Bezeichner aus dem Quellsystem.
Front-End	Referenz	Verweis auf das API-Frontend (cmdb_ci_api_Frontend).
Verwaltete API	Referenz	Verweis auf die verwaltete API (cmdb_ci_Managed_api).
Verbraucher	Referenz	Verweis auf die nicht-CMDB-Tabelle „API-Verbraucher“ (api_Consumer). Hinweis: Verbraucher Ist ein Referenzfeld. Um api_Consumer (Anwendername) in der API-Richtlinienliste anzuzeigen, müssen Sie festlegen displayAttribut zu `Wahr` Für Anwendername Feld in der Tabelle „api_Consumer“. Wenn das Attribut nicht auf festgelegt ist `Wahr` , Dann zeigt die Liste stattdessen die SYS-ID an.
Protokolle	Zeichenfolge	Array von Protokollen, für die diese API-Richtlinie gelten kann.
Aktiv	Boolean	Bestimmt, ob diese nicht-CMDB-Tabelle als aktiv oder inaktiv betrachtet wird.
API-Gateway	Referenz	Verweis auf das Gateway, in dem der Verbraucher definiert ist (cmdb_ci_api_Gateway).