API-Erweiterungsklassen

Freigeben Version: Yokohama

Aktualisiert 30. Januar 2025

5 Minuten Lesedauer

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

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

APIs

APIs sind eine Reihe von Definitionen und Protokollen, mit denen Computerprogramme miteinander kommunizieren können, 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 Aufträge oder Aufgaben programmgesteuert auszuführen oder Daten anzuzeigen, zu importieren, zu exportieren, zu löschen oder zu ändern.

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

Verschaffen Sie sich einen besseren Überblick über Ihre APIs.
Identifizieren Sie Sicherheitsprobleme und Schwachstellen im Zusammenhang mit einem API-Endpunkt.

Klassen

In diesem Abschnitt werden die Klassen aufgelistet, die von der Store-App CMDB CI-Klassenmodelle hinzugefügt oder aktualisiert werden. Weitere Informationen finden Sie im Community-Artikel mit dem Titel „Neues Datenmodell in CMDB für APIs“.

CMDB CI-Klassenmodelle: Release 1.49.0 fügt die folgenden Klassen für APIs hinzu. Die Liste der Klassen in Basissystem, einschließlich der Klassen, die diese App möglicherweise erweitert, finden Sie unter Beschreibungen der CMDB-Tabellen.


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 „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 sendet. 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, die von einem Gateway oder Verwaltungsservice erkannt wurde. 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 aus 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.
Spez. Speicherort	URL	URL zum Speicherort der API-Spezifikation. Beispiel: OpenAPI-Spezifikationsdefinition.

Tabelle : 2. API-Komponente [cmdb_ci_api_component]
Attribut	Datentyp	Beschreibung
Methode	Zeichenfolge	REST API-Methoden. Beispiele: GET POST DELETE
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 Key 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

Tabelle : 3. API-Front-End [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.

Hinweis:

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

Schlüsselbeziehungsstrukturen

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

Tabelle : 6. 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 Folgendes 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

Zugehörige Nicht-CMDB-Tabellen

CMDB CI-Klassenmodelle Mit v 1.49.0 werden diese Nicht-CMDB-Tabellen als zugehörige Listen für die folgenden API-Erweiterungsklassen eingeführt:

Zugehörige API-Liste

Tabelle : 7. 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 Configuration Item. Wird normalerweise manuell als Referenz angegeben, wenn Sie wissen, für welches CI die API bereitgestellt wird.

Hinweis:

Die Nicht-CMDB-Tabelle der API-Bereitstellung bezieht sich auf die Klassen API [cmdb_ci_api] und „Nicht abgeglichener API-Endpunkt“ [cmdb_ci_unmatched_api_endpoint].

Zugehörige Liste „API-Komponente“.

Tabelle : 8. 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 (cmdb_ci_unmatched_endpoint) abgeglichen werden kann.

Zugehörige Listen „API-Gateway“.

Tabelle : 9. API-Verbraucher [api_consumer]
Attribut	Datentyp	Beschreibung
Anwendername	Zeichenfolge (100)	Name des API-Verbrauchers. Hinweis: Das Feld Verbraucher in der Tabelle api_policy ist ein Referenzfeld. Um den Anwendernamen im Feld Anwendername in der Liste der API-Richtlinien anzuzeigen, müssen Sie das Attribut display des Anwendernamens auf `true`festlegen. Wenn das Attribut nicht auf `true`festgelegt ist, wird stattdessen die Sys-ID in der Liste angezeigt.
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).

Tabelle : 10. 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-Front-End (cmdb_ci_api_frontend)
Verwaltete API	Referenz	Verweis auf die verwaltete API (cmdb_ci_managed_api)
Verbraucher	Referenz	Verweis auf die Nicht-CMDB-Tabelle des API-Verbrauchers (api_consumer). Hinweis: Verbraucher ist ein Referenzfeld. Um „api_consumer“ (Anwendername) in der Liste „API-Richtlinien“ anzuzeigen, müssen Sie das Attribut display für das Feld „Anwendername“ in der Tabelle „api_consumer“ auf `„wahr“` setzen. Wenn das Attribut nicht auf `true`festgelegt ist, wird stattdessen die Sys-ID in der Liste angezeigt.
Protokolle	Zeichenfolge	Array von Protokollen, auf die diese API-Richtlinie angewendet werden 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).