Die neuesten API-Informationen finden Sie, indem Sie sich bei Cloud Insights anmelden und zu Admin > API Acccess navigieren. Klicken Sie auf den Link API Documentation.

Die API-Dokumentation ist Swagger-basiert, die eine kurze Beschreibung und Verwendungsinformationen für die API, und ermöglicht es Ihnen, es in Ihrer Umgebung zu testen. Je nach Benutzerrolle und/oder Cloud Insights Edition können die für Sie verfügbaren API-Typen variieren.

Bevor Sie die Cloud Insights-API verwenden, müssen Sie ein oder mehrere API-Zugriffstoken erstellen. Access Tokens werden für angegebene API-Typen verwendet und können Lese- und/oder Schreibberechtigungen gewähren. Sie können auch die Ablauffrist für jedes Access Token festlegen. Alle APIs unter den angegebenen Typen sind für das Access-Token gültig. Jedes Token ist ungültig für einen Benutzernamen oder ein Kennwort.

So erstellen Sie ein Access Token:

Sie können Token deaktivieren, aktivieren und widerrufen. Deaktivierte Token können aktiviert werden.

Tokens gewähren aus Kundensicht allgemeinen Zugang zu APIs; Management des Zugriffs auf APIs im Umfang ihres eigenen Mandanten. Kundenadministratoren können diese Token ohne direkte Beteiligung von Cloud Insights Back-End-Mitarbeitern erteilen und widerrufen.

Die Anwendung erhält ein Zugriffstoken, nachdem ein Benutzer den Zugriff erfolgreich authentifiziert und autorisiert hat, und übergibt das Access Token dann als Berechtigung, wenn es die Ziel-API anruft. Das übergebene Token informiert die API, dass der Inhaber des Tokens berechtigt ist, auf die API zuzugreifen und bestimmte Aktionen durchzuführen, die vom Umfang festgelegt wurden, der während der Autorisierung gewährt wurde.

Der HTTP-Header, in dem das Access Token übergeben wird, ist X-CloudInsights-ApiKey:.

Verwenden Sie zum Abrufen von Lagerbeständen beispielsweise Folgendes:

Beispiele für die API, die Sie verwenden möchten, finden Sie auf den Seiten der Schwagger.

Die Cloud Insights-API ist kategoribasiert und enthält derzeit die folgenden Typen:

Weitere Typen und/oder APIs können im Laufe der Zeit verfügbar sein. Die neuesten API-Informationen finden Sie im "API-Swagger-Dokumentation".

Beachten Sie, dass die API-Typen, auf die ein Benutzer Zugriff hat, auch vom abhängen "Benutzerrolle" Sie werden in allen Cloud Insights Funktionen eingesetzt (Monitoring, Workload-Sicherheit, Berichterstellung).

In diesem Abschnitt wird beschrieben, wie eine Hierarchie von Cloud Insights-Objekten durchlaufen wird.

Viele API-Befehle unterstützen den Parameter Expand, der zusätzliche Details zum Objekt oder URLs für verwandte Objekte enthält.

Der gemeinsame Expand-Parameter ist Expands. Die Antwort enthält eine Liste aller verfügbaren spezifischen Expands für das Objekt.

Beispiel: Wenn Sie Folgendes anfordern:

Jede Erweiterung enthält Daten, eine URL oder beides. Der Parameter Expand unterstützt mehrere und verschachtelte Attribute, z. B.:

Um dies zu entmutigen, können Anfragen nach Beständen der obersten Ebene nicht erweitert werden. Beispielsweise können Sie keine Expand-Daten für alle Speicherobjekte gleichzeitig anfordern. Die Clients müssen die Liste der Objekte abrufen und dann spezifische Objekte auswählen, die erweitert werden sollen.

Performancedaten werden über viele Geräte als separate Proben erfasst. Jede Stunde (Standard) Cloud Insights aggregiert und fasst Performance-Muster zusammen.

Die API ermöglicht den Zugriff auf sowohl die Proben als auch auf die zusammengefassten Daten. Bei einem Objekt mit Performance-Daten ist eine Performance-Zusammenfassung als Expand=Performance verfügbar. Die Zeitreihen für den Leistungsverlauf sind über die verschachtelte_Expand=Performance.history_ verfügbar.

Beispiele für Performance-Datenobjekte:

Eine Leistungsmetric hat eine Beschreibung und einen Typ und enthält eine Sammlung von Leistungsübersichten. Beispiel: Latenz, Datenverkehr und Rate.

Eine Leistungsübersicht enthält eine Beschreibung, Einheit, Beispielstartzeit, Probenendzeit und eine Sammlung von zusammengefassten Werten (Strom, min, max, avg usw.), die aus einem einzelnen Leistungszähler über einen Zeitbereich (1 Stunde, 24 Stunden, 3 Tage usw.) berechnet werden.

Das resultierende Wörterbuch für Leistungsdaten enthält die folgenden Schlüssel:

Jeder Performance-Datenobjekttyp verfügt über einen eigenen Satz von Performance-Kennzahlen. Das Performance-Objekt der virtuellen Maschine unterstützt beispielsweise „diskThrughput“ als Leistungskennzahl. Jede unterstützte Leistungsmetrik ist eine bestimmte „performanceCategory“, die im metrischen Wörterbuch dargestellt wird. Cloud Insights unterstützt verschiedene Performance-Kennzahlen, die später in diesem Dokument aufgeführt sind. Jedes Wörterbuch der Leistungsmetrik hat auch das Feld „Beschreibung“, das eine vom Menschen lesbare Beschreibung dieser Leistungsmetrik und eine Reihe von Zähleinträgen mit Leistungszusammenfassung ist.

Der Zähler der Leistungsübersicht ist die Zusammenfassung der Leistungsindikatoren. Er zeigt typische aggregierte Werte wie Min., Max. Und Avg für einen Zähler sowie den neuesten beobachteten Wert, den Zeitbereich für zusammengefasste Daten, den Einheitstyp für Zähler und die Schwellenwerte für Daten. Nur Schwellenwerte sind optional; die restlichen Attribute müssen angegeben werden.

Leistungsübersichten stehen für diese Zählertypen zur Verfügung:

Die API kann detaillierte Metriken für Objekte in Ihrer Umgebung zurückgeben, z. B.:

Siehe "API-Swagger-Dokumentation" Weitere Informationen zu Metriken für die einzelnen Objekttypen.

Verlaufsdaten werden in Leistungsdaten als Liste der Zeitstempel- und Zählermaps-Paare präsentiert.

Verlaufszähler werden basierend auf dem Objektnamen der Performance-Metrik benannt. Das Performance-Objekt der virtuellen Maschine unterstützt beispielsweise „diskThrughput“, so dass die Geschichtskarte Schlüssel mit den Namen „diskThrughput.read“, „diskThrughput.write“ und „diskThrughput.total“ enthält.

Dies ist ein Beispiel für einen Performance-Daten-JSON für eine Festplatte:

Objekte mit Kapazitätsattributen verwenden grundlegende Datentypen und das kapazitätItem zur Darstellung.

Die Such-API ist ein einfacher Einstiegspunkt zum System. Der einzige Eingabeparameter für die API ist eine freie Zeichenfolge, und der resultierende JSON enthält eine kategorisierte Liste der Ergebnisse. Typen sind verschiedene Asset-Typen aus dem Inventar, z. B. Speicher, Hosts, Datenspeicher usw. Jeder Typ würde eine Liste von Objekten des Typs enthalten, die den Suchkriterien entsprechen.

Cloud Insights ist eine erweiterbare (offene) Lösung, die die Integration in Orchestrierungs-, Business-Management-, Änderungs- und Ticketsysteme anderer Anbieter sowie in individuelle CMDB-Integrationen ermöglicht.

Die RESTful API von Cloud Insight ist ein primärer Integrationspunkt für eine einfache und effektive Datenverschiebung und ermöglicht Anwendern nahtlosen Zugriff auf ihre Daten.

Um ein API-Token vorübergehend zu deaktivieren, klicken Sie auf der API-Token-Listenseite auf das Menü „drei Punkte“ für die API und wählen Sie Disable. Sie können das Token jederzeit über dasselbe Menü wieder aktivieren und Enable auswählen.

Um ein API-Token dauerhaft zu entfernen, wählen Sie im Menü die Option „Widerruf“. Sie können ein entzogen Token nicht erneut aktivieren; Sie müssen ein neues Token erstellen.

Die Token für den API-Zugriff haben ein Ablaufdatum. Wenn ein API-Zugriffstoken abläuft, müssen Benutzer ein neues Token generieren (vom Typ Datenaufnahme mit Lese-/Schreibberechtigungen) und Telegraf neu konfigurieren, um das neu generierte Token anstelle des abgelaufenen Tokens zu verwenden. In den folgenden Schritten wird die Vorgehensweise beschrieben.