Auf die API-Detailseite zugreifen und sie verwenden

Um auf die Seite „API-Details“ zuzugreifen, navigieren Sie zu Arbeitsbereiche > API-Einblicke, wählen Sie die Registerkarte APIs und dann eine API aus der Namensspalte der API-Tabelle aus.

Daten werden angezeigt

Standardmäßig werden auf der Seite die folgenden Daten angezeigt:

• Header-Region
• Metadatenbereich
• Zugehörige Listen
• Übersichtsbereich
• Verwendung
• Sicherheit
• Events
• Beziehungszuordnung

Header-Region

Zeigt den Namen der API, Versionsinformationen und die aktuelle Lebenszyklusphase der API an, z. B. Funktionsfähig oder Ende der Lebensdauer.

Über die Liste Anzeigen nach können Sie, falls verfügbar, zwischen verschiedenen Verwaltungsplattformen wechseln, unter denen die API verwaltet wird.

Die Versionsauswahl ermöglicht die Auswahl verschiedener Versionen der API zum Anzeigen und Verwalten. Wählen Sie Aktualisieren aus, um die Details basierend auf der ausgewählten Version zu aktualisieren.

Hinweis:

Die Liste Anzeigen nach und die Versionsauswahl werden nur angezeigt, wenn zutreffend für eine API.

Metadatenbereich

Zeigt die folgenden Felder an.

Feld	Beschreibung
Beschreibung	Kurze Zusammenfassung oder Zweck der API.
Zuletzt erkannt	Letztes Datum, an dem die API in CMDBerkannt oder aktualisiert wurde.
Discovery-Quelle	Quelle, in der die API erkannt wurde.
Typ	Typ der API: geskriptete REST-API, HTTP-API, Plattform-REST-API usw.
Besitzgruppe	Team oder Gruppe, das bzw. die für die Verwaltung der API verantwortlich ist.
Digitale Schnittstelle	Interaktionsmethode der API im System.

Zugehörige Listen

Zeigt die folgenden Felder an.

Feld	Beschreibung
Zugriffsanforderungen erhalten	Zeigt die Anzahl der Zugriffsanforderungen an, die für die API gestellt wurden. Wählen Sie die auf der Karte angezeigte Nummer aus, um Details zur Zugriffsanforderung anzuzeigen.
Verbraucher	Zeigt die Anzahl der Verbraucher der API an.
Bereitstellungen	Gibt alle aktiven oder früheren Bereitstellungen der API in allen Umgebungen an.

Übersichtsbereich

Listet alle verfügbaren Vorgänge (Endpunkte) der API auf. Wählen Sie einen Endpunkt aus, um die entsprechenden Details anzuzeigen.

Monatlich

Zeigt die folgenden Felder an.

Feld	Beschreibung
Tägliche Anforderungen	Anzahl der API-Komponentenanforderungen im Zeitverlauf, dargestellt als Liniendiagramm, wobei die x-Achse den Datumsbereich und die y-Achse die Anzahl der Anforderungen anzeigt.
Anforderungen nach Version (letzte 10 Tage)	Verteilung der API-Anforderung auf verschiedene Versionen in den letzten 10 Tagen.
Geschäftsanwendungen	Anzahl der Geschäftskontexte, die auch als mit dem API-Design verknüpfte Geschäftsanwendung bezeichnet werden, wie im Datensatz der digitalen Schnittstelle widergespiegelt.

Sicherheit

Zeigt die folgenden Felder an.

Feld	Beschreibung
Aktive angreifbare Elemente	Mit der API verbundene Sicherheitsschwachstellen, die die Nachverfolgung und Lösung potenzieller Risiken ermöglichen.
Security Incidents	Security Incidents, sofern aktiviert, die Einblicke in Sicherheitsverletzungen oder Probleme geben, die bei der API aufgetreten sein könnten.

Ereignisse

Zeigt die folgenden Felder an.

Feld	Beschreibung
Kritische Warnungen	Kritische Warnungen des IT-Betriebs im Zusammenhang mit der API, die die Identifizierung schwerwiegender Probleme ermöglichen, die sich auf die Leistung der API auswirken könnten.
Incidents	Aufgezeichnete Incidents, wie z. B. Ausfälle, Change-Anforderungen oder Probleme im Zusammenhang mit der API, die für die Nachverfolgung der betrieblichen Integrität und von Korrekturmaßnahmen unerlässlich sind.

Beziehungszuordnung

Bietet eine hierarchische Übersicht über die API-Beziehungen mit ihren Komponenten, Verwaltungsplattformen, Geschäftsanwendungen und Designsund erleichtert so das Verständnis der Rolle der API innerhalb der breiteren Systemarchitektur. Darüber hinaus bietet die Option zum Verwalten von Anwendungsservice-Beziehungen. Siehe Anwendungsservice-Beziehungen für APIs verwalten.

Eine Beziehungszuordnung ist eine partielle einheitliche Zuordnung, ähnlich der in CMDB-Arbeitsbereichverwendeten. Um die einheitliche Übersicht für APIs zu öffnen, wählen Sie Vollständige Übersicht öffnen im Abschnitt „Beziehungszuordnung“ der Seite „API-Details“. Weitere Informationen finden Sie unter Einheitliche Übersicht.

Knoten in der Zuordnung repräsentieren die API und ihre Komponenten in CMDB, und Linien stellen Verbindungen und Beziehungen zwischen API-Komponenten dar. Die Verbindungen helfen Ihnen beispielsweise, die Auswirkungen einer Änderung an einem ausgewählten Knoten zu bewerten, indem Komponenten angezeigt werden, die über Beziehungen und Referenzen mit ihm verbunden sind. Produkte wie Change Management, Incident Managementund Event Management profitieren von solchen Informationen.

Die Zuordnung zeigt auch die Zusammensetzung der Anwendungsservices an – nützlich bei Produkten wie Event Management und Incident Management. Sie können historische Changes überprüfen.

Die folgenden Elemente sind in der einheitlichen Übersicht für APIs verfügbar:

1: Zuordnung

In der Zuordnung werden die angegebene API und ihre Verbindungen und Beziehungen angezeigt. Im Beispiel ist httpbin.org-v1.1 der Startknoten, und die Linien stellen Verbindungen und Beziehungen zu anderen Komponenten dar. Wählen Sie einen beliebigen Knoten aus, um Details wie zugehörige Anwendungsservices und die Change-Historie anzuzeigen.

2: Inhaltssteuerelemente

• Suchen Sie nach dem Startknoten, und wählen Sie ihn aus, geben Sie die Anzahl der Beziehungsebenen für Anwendungsservices an, und laden Sie die Zuordnung neu, nachdem Sie Änderungen vorgenommen haben.
• Verwenden Sie Filter, um die Typen und Beziehungstypen einzuschränken, die in der Zuordnung angezeigt werden.
• Blenden Sie die Zeitleiste der Ereignisse (zugehörige Elemente) für die ausgewählte API ein oder aus

3: Toolbox

Verwenden Sie die Toolbox, um verschiedene visuelle Aspekte der Karte zu steuern, z. B. die Zoomstufe oder den Layoutmodus.

4: Kontextbezogener Seitenbereich

• Im Bereich Attribute ( ) werden Attribute wie Standort und Betriebsstatus für die ausgewählte API oder Beziehung aufgelistet.
• Im Bereich Anwendungsservices ( ) werden Details zu Anwendungsservices aufgelistet, die der ausgewählten API zugeordnet sind.
• Im Bereich Zugehörige Elemente ( ) werden zugehörige Elemente wie aktive Incidents oder aktive Probleme für die ausgewählte API angezeigt.
• Im Bereich Changes ( ) werden Changes aufgelistet, z. B. Changes am Betriebsstatus für die ausgewählte API.

5: Minikarten-Navigator

Legen Sie die Zoomstufe fest, oder verschieben Sie die Ansicht in einen Interessenbereich. Wählen Sie das Symbol, um den Navigator ein- oder auszublenden.

6: Zeitleiste

Die Zeitleiste zeigt Events (zugehörige Elemente) wie Incidents, Probleme und Changes für die ausgewählte API über einen bestimmten Zeitraum an. Sie können die Zeitleiste verwenden, um den Verlauf der Änderungen an einer API und deren Auswirkungen auf die Topologie von CMDBanzuzeigen.