Zum Inhalt springen

API-Voraussetzungen Observability

Zuletzt aktualisiert am

Um die auf dieser Seite beschriebenen Schritte ausführen zu können, müssen die folgenden Bedingungen erfüllt sein:

Zugriff auf Projekt-ID, Instanz-ID und API-URLs für Anfragen

Abschnitt betitelt „Zugriff auf Projekt-ID, Instanz-ID und API-URLs für Anfragen“

Die Dokumentation der API finden Sie hier. Um API-Anfragen zu stellen, müssen Sie die beiden folgenden IDs kennen:

  • Projekt-ID: Um auf Ihre Projekt-ID zuzugreifen, wählen Sie den Link Dashboard unter Übersicht in der linken Navigation. Die Projekt-ID kann dann aus dem Bereich mit den Projektinformationen kopiert werden.
  • Instanz-ID: Um auf Ihre Instanz-ID zuzugreifen, wählen Sie den Link Observability unter Logging & Monitoring in der linken Navigation. Wählen Sie nun die Observability-Instanz aus, deren Instanz-ID Sie benötigen. Wählen Sie die Übersicht in der linken Navigation; die Instanz-ID kann nun im Bereich Allgemeine Informationen abgelesen werden.

Die Bearer-Token-Authentifizierung ist die empfohlene Art der Authentifizierung.

Um ein Bearer-Token zu erstellen, müssen Sie zunächst einen Dienstkonto erstellen, für das Sie dann ein Zugriffstoken erstellen. Weitere Informationen zu diesem Prozess finden Sie hier: Dienstkonto erstellen.

Authorization: Bearer <Ihr Service Account Zugriffstoken>

Screenshot der Benutzeroberfläche eines API-Clients (wie Postman), der eine GET-Anfrage zeigt. Im aktiven Reiter „Headers“ sind zwei Schlüssel-Wert-Konfigurationszeilen ausgewählt: Den Schlüssel „Authorization“ und den Schlüssel „Accept“.

Obwohl die Basic-Authentifizierung weiterhin unterstützt wird, sollte sie nur für die folgenden Aufgaben verwendet werden:

  • Remote-Writing von Metriken
  • Übertragen von Logs
  • Übertragen von Traces
  • Zugriff auf Produkt-Frontends (z. B. Prometheus)

Beachten Sie, dass sich die Basis-URLs unterscheiden, je nachdem, ob die Basic-Authentifizierung oder die Bearer-Authentifizierung verwendet wird:

  • Basic-Auth: Verwenden Sie
https://api.argus.eu01.stackit.cloud
  • Bearer-Auth: Verwenden Sie
https://argus.api.eu01.stackit.cloud

Um mit der API zu arbeiten, müssen Sie einen API-Benutzer erstellen.

  1. Wählen Sie Ihr STACKIT-Projekt und den Dienst Observability aus, für den Sie einen neuen API-Benutzer erstellen möchten.
  2. Öffnen Sie im Dashboard von Observability den Tab API und wählen Sie den Bereich Zugangsdaten.
  3. Klicken Sie auf Zugangsdaten erstellen, um einen neuen API-Benutzer zu erstellen.
    Screenshot des anfänglich leeren Bereichs „Zugangsdaten“ („Credentials“) im Observability-Dashboard des STACKIT-Portals. Das linke Navigationsmenü hebt den Eintrag „Credentials“ unter der Kategorie „API“ hervor. Der Hauptbereich zeigt die Meldung „No credentials created yet“. Es sind zwei gelbe Schaltflächen mit der Aufschrift „+ Create credentials“ zu sehen – eine am oberen Rand und eine unterhalb des Hinweises.
    → Sie erhalten einen neuen zufälligen Namen und ein Passwort.

Sie müssen den Authorization-Header bei jeder Anfrage mit Ihren Zugangsdaten setzen.

Erstellen Sie den Authorization-Header-String wie folgt:

Beispiel:

Screenshot der Benutzeroberfläche eines API-Clients, konfiguriert für eine POST-Anfrage. Im aktiven Reiter „Headers“ sind zwei Zeilen ausgewählt: Der Schlüssel „Authorization“ ist auf einen Wert gesetzt, der mit „Basic c3R...“ beginnt, und der Schlüssel „Accept“ ist auf „application/json“ eingestellt.