Monitoring Management API der API verwenden

Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation weitere Informationen

Verwenden Sie die API-Überwachungsverwaltungs-API, um die folgenden Aufgaben auszuführen.

Aufgabe Weitere Informationen
Benachrichtigungen für API-Monitoring verwalten
Sammlungen für API-Monitoring verwalten
API-Monitoring-Logs auf verschiedenen Ebenen ansehen
API-Monitoring-Messwerte ansehen

API-Aufrufkontingente

Alle API-Monitoring APIs setzen ein Kontingent durch, das die Anzahl der API-Aufrufe pro Minute begrenzt. Die API Create collections ist beispielsweise auf sechs Aufrufe pro Minute beschränkt.

Nicht alle Projekte verfügen über dieselben Kontingentlimits. Informationen zum Ermitteln des Limits finden Sie in der API-Referenzdokumentation zu den einzelnen APIs.

curl verwenden

In den API-Beispielen in diesem Dokument wird mithilfe von curl gezeigt, wie das API-Monitoring mithilfe der API verwendet wird. curl ist ein Open-Source-Befehlszeilentool zum Übertragen von Daten mit URL-Syntax, das gängige Protokolle wie HTTP und HTTPS unterstützt. Informationen zum Herunterladen und Verwenden von curl finden Sie unter https://curl.haxx.se/.

In der folgenden Tabelle sind die in den Beispielen verwendeten Befehlszeilenoptionen zusammengefasst.

Option Beschreibung
-d '{}'

--data @filename

Definiert den Anfragetext, der direkt übergeben wird oder einen Dateinamen angibt.
-H

--header

Definiert einen Anforderungsheader. Im Anfrageheader müssen folgende Informationen übergeben werden:
  • OAuth 2.0-Token für die Nutzerauthentifizierung mit dem Header Authorization, wie unter OAuth 2.0-Zugriffstoken abrufen beschrieben.
  • Inhaltstypen, die vom Client mit dem Header Accept unterstützt werden.
  • Inhaltstyp des Anfragetexts, der gesendet wird, wenn eine Ressource (POST, PATCH, PUT) mit dem Content-Type-Header erstellt oder aktualisiert wird.
-i Zeigt in der Antwort weitere Informationen an, z. B. Kopfzeilen.
-X Gibt den Anfragetyp an (GET, POST usw.).

OAuth 2.0-Zugriffstoken abrufen

Apigee Edge unterstützt OAuth 2.0 für die Nutzerauthentifizierung. Mit OAuth 2.0 tauschen Sie Ihre Apigee Edge-Anmeldedaten gegen ein Zugriffstoken und ein Aktualisierungstoken aus, mit denen Sie anschließend sichere Aufrufe der Apigee Edge-API durchführen können. Sobald Sie ein Token erhalten, müssen Sie Ihre Anmeldeinformationen nicht erneut austauschen, bis das Token abläuft. Mit dem Aktualisierungstoken können Sie Ihre "Sitzung" mit dem Server über einen längeren Zeitraum am Leben halten, ohne Ihre Anmeldedaten anzugeben. Weitere Informationen zu Zugriffstokens finden Sie unter Verwenden von OAuth2 für den Zugriff auf die Verwaltungs-API.

Mit Ihren Apigee Edge-Anmeldedaten können Sie OAuth 2.0-Zugriff erhalten und Tokens aktualisieren, um auf Apigee Edge-Ressourcen mit dem Dienstprogramm get_token von Apigee zuzugreifen.

So erhalten Sie ein OAuth 2.0-Zugriffstoken:

  1. Installieren Sie das Dienstprogramm get_token: Informationen zum Installieren des Dienstprogramms get_token finden Sie unter get_token verwenden.

  2. Führen Sie get_token aus, um ein OAuth 2.0-Zugriffstoken zu erhalten.

    Wenn Sie den Befehl zum ersten Mal eingeben oder wenn das Aktualisierungstoken abgelaufen ist, werden Sie von get_token aufgefordert, Ihren Nutzernamen, Ihr Passwort und den sechsstelligen Zwei-Faktor-Authentifizierungscode einzugeben. Geben Sie jeden Wert ein, wenn Sie dazu aufgefordert werden. Wenn Sie die Bestätigung in zwei Schritten nicht aktiviert haben, drücken Sie einfach die Eingabetaste, wenn Sie dazu aufgefordert werden.

  3. Kopieren Sie das OAuth 2.0-Token und speichern Sie es in einer Variablen wie ACCESS_TOKEN: 

    export ACCESS_TOKEN=eyJhbGciOiJSUzI1NiJ9.eyJqdGkiOiI2NmQ4MTRiMC01YzZkLTQyZWUtYjlmYi05ZGVhODk5MGRiODIiLCJzdWIiOiJlZjc3YmRhMS05ZWIxLTQyZDgtODg5MC0zODQ3ODg0MzM1OWIiLCJzY29wZSI6WyJzY2ltLmVtYWlscy5yZWFkIiwicGFzc3dvcmQud3JpdGUiLCJhcHByb3ZhbHMubWUiLCJzY2ltLm1lIiwic2NpbS5pZHMucmVhZCIsIm9wZW5pZCIsIm9hdXRoLmFwcHJvdmFscyJdLCJjbGllbnRfaWQiOiJlZGdlY2xpIiwiY2lkIjoiZWRnZWNsaSIsImF6cCI6ImVkZ2VjbGkiLCJncmFudF90eXBlIjoicGFzc3dvcmQiLCJ1c2VyX2lkIjoiZWY3N2JkYTEtOWViMS00MmQ4LTg4OTAtMzg0Nzg4NDMzNTliIiwib3JpZ2luIjoidXNlcmdyaWQiLCJ1c2VyX25hbWUiOiJsbHluY2hAYXBpZ2VlLmNvbSIsImVtYWlsIjoibGx5bmNoQGFwaWdlZS5jb20iLCJyZXZfc2lnIjoiZTViZDc3NjIiLCJpYXQiOjE0NzA3NTMyMDksImV4cCI6MTQ3MDc5NjQwOSwiaXNzIjoiaHR0cHM6Ly9sb2dpbi5lMmUuYXBpZ2VlLm5ldC9vYXV0aC90b2tlbiIsInppZCI6InVhYSIsImF1ZCI6WyJzY2ltIiwicGFzc3dvcmQiLCJvcGVuaWQiLCJlZGdlY2xpIiwiYXBwcm92YWxzIiwic2NpbS5lbWFpbHMiLCJzY2ltLmlkcyIsIm9hdXRoIl19.FF3f1i9eHbBqYjnvBmt9nTtTcyNQBQRDDq2tQ3aRUAzUesLAet7qfBB9QVCvE-zVBn4BiPgRU-iturxPxRMAQ2a34-8oLvgff3x-aALBWkSwbc8PJdWTiPP9VYykoFSJtu9UIN5x0FQEQN_hyurO8D2SrS3uQKNwIyjoJPy4Bps7nb3WqJyKRfXAzf8UptdN7XE0TVqTyBcZGT3OQ2Was0VPfe_dr-wIrywvjNf6FczjdktB1lpKJ2oRXx1n8PuK5FhOQ4wE9VeSsNsMHVcGvJ5W6Tvi61fo2h1w1d4AKvGdERzuVf_XWN00mtcgwsUAuXV0r5H_i3vxcMuUym1XOg

Wenn Sie die API-Monitoring API aufrufen, übergeben Sie das OAuth 2.0-Zugriffstoken im HTTP-Header mit dem Authorisierungsheader. Beispiel:


curl -X GET "https://apimonitoring.enterprise.apigee.com/alerts?org=myorg"
   -H "Authorization: Bearer $ACCESS_TOKEN" 
   ...