Add-on für API-Analysen von Apigee verwalten

Diese Seite gilt für Apigee, aber nicht für Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

Apigee API Analytics erfasst und berechnet eine Fülle von Informationen, die über API-Proxys fließen. Sie können diese Daten mit Grafiken und Diagrammen in der Apigee UI visualisieren oder die Rohdaten für die Offlineanalyse mithilfe der Apigee APIs herunterladen. Weitere Informationen zu den Datentypen, die Sie mit Apigee API Analytics erfassen und analysieren können, finden Sie unter Apigee Analytics.

Wenn Sie Apigee „Pay as you go“-Kunde sind, ist Apigee API Analytics als kostenpflichtiges Add-on verfügbar. In diesem Thema wird beschrieben, wie Sie das Apigee API Analytics-Add-on für geeignete „Pay as you go“-Umgebungen aktivieren und verwalten. Weitere Informationen zur Verwendung der Apigee API Analytics-Dashboards nach dem Aktivieren des Add-ons in Ihren Apigee-Umgebungen finden Sie unter Analyse-Dashboards verwenden.

Verfügbarkeit

Apigee API Analytics ist als kostenpflichtige Add-on-Funktion verfügbar, die für jede Apigee-Umgebung in Ihrer Apigee-Implementierung verwaltet wird. Das Add-on kann in jeder Apigee-Zwischenphase oder der umfassenden Umgebung aktiviert werden. Sie können Apigee API Analytics nicht in Basisumgebungen aktivieren und verwenden. Weitere Informationen zu den Funktionen der Apigee-Umgebung finden Sie unter Vergleich der Umgebungstypen.

Erforderliche Rollen und Berechtigungen

Bitten Sie Ihren Administrator, Ihnen den Administrator der Apigee-Umgebung (apigee.environment.admin) zu gewähren, um die Berechtigungen zu erhalten, die Sie zum Verwalten des Apigee API Analytics-Add-ons für das Projekt benötigen. Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.

Diese vordefinierte Rolle enthält die Berechtigungen, die zum Verwalten des Add-ons "Apigee API Analytics" erforderlich sind. Erweitern Sie den Abschnitt Erforderliche Berechtigungen, um die erforderlichen Berechtigungen anzuzeigen:

Erforderliche Berechtigungen

Die folgenden Berechtigungen sind erforderlich, um das Apigee API Analytics-Add-on zu verwalten:

  • apigee.addonsconfig.get
  • apigee.addonsconfig.update

Sie können diese Berechtigungen auch mit benutzerdefinierten Rollen oder anderen vordefinierten Rollen erhalten.

Apigee API Analytics-Add-on aktivieren

Sie können das Add-on für die Apigee API-Analyse für Mittel oder Umfassend Apigee-Umgebung über die Apigee-UI in der Google Cloud Console oder mithilfe der API, wie in den folgenden Abschnitten beschrieben.

Apigee in der Google Cloud Console

So aktivieren Sie das Apigee API Analytics-Add-on in der Google Cloud Console:

  1. Öffnen Sie in der Console die Seite Apigee.

    Zu „Apigee“

  2. Wählen Sie das Projekt mit der „Pay as you go“-Organisation und Umgebungen aus, die Sie verwalten möchten.
  3. Wählen Sie Add-ons > Analysen aus, um die Seite Analytics-Add-on zu öffnen.
  4. Klicken Sie im Bereich Apigee API Analytics-Add-on verwalten das Kästchen für die Umgebung (oder Umgebungen) an, in denen Sie das Add-on aktivieren möchten.
  5. Klicken Sie auf Auswahl aktivieren.
  6. Wenn die Aktivierung für die ausgewählten Umgebungen abgeschlossen ist, wird der Status der Umgebung Aktiviert angezeigt.
  7. Wählen Sie Analytics > API-Messwerte aus, um Ihre Analysedaten aufzurufen. Es kann bis zu zehn Minuten dauern, bis die Analysedaten angezeigt werden.

Apigee API

Geben Sie den folgenden Befehl ein, um das Apigee API Analytics-Add-on mit der Apigee API zu aktivieren: 

curl -X POST \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig:setAddonEnablement \
      -H "Authorization: Bearer $token" \
      -H "Content-type: application/json" \
      -d '{"analyticsEnabled":true}'

Wobei:

  • ORG_NAME ist der Name der „Pay as you go“-Organisation von Apigee, der Sie Analytics zu berechtigten Umgebungen hinzufügen möchten.
  • ENV_NAME ist der Name der Apigee-Umgebung, in der Sie das Apigee API Analytics-Add-on aktivieren möchten.

Wählen Sie nach der Aktivierung Analytics > API-Messwerte aus, um Ihre Apigee API Analytics-Daten aufzurufen. Es kann bis zu zehn Minuten dauern, bis die Analysedaten in der Benutzeroberfläche angezeigt werden oder über einen API-Aufruf verfügbar sind.

Der Aktivierungsvorgang des Apigee API Analytics-Add-ons kann bis zu 15 Minuten dauern. Nach der Aktivierung werden Analysedaten für die Umgebung 14 Monate lang gespeichert. Sie können auf die Verlaufsdaten der Umgebung über die API-Messwerte in der Console zugreifen, solange das Add-on aktiviert ist.

Die Abrechnung für die Verwendung des Add-ons "Apigee API Analytics" beginnt, sobald das Add-on aktiviert wird.

Apigee API Analytics-Add-on deaktivieren

Sie können das Apigee API Analytics-Add-on für eine Zwischen- oder umfassende Apigee-Umgebung über die Apigee-UI in der Google Cloud Console oder die API deaktivieren, wie in den folgenden Abschnitten beschrieben.

Wenn Sie das Add-on „Erweiterte API-Sicherheit“ in der Umgebung aktiviert haben, müssen Sie das Add-on „Erweiterte API-Sicherheit“ deaktivieren, bevor Sie das Apigee API-Analytics-Add-on deaktivieren können. Wenn das Add-on „Erweiterte API-Sicherheit“ nicht deaktiviert ist, schlägt jede Anfrage zum Deaktivieren von Apigee API Analytics in der Umgebung fehl. Wenn das Add-on für die erweiterte API-Sicherheit in Ihrer Umgebung aktiviert ist, wird es in der Spalte Sonstige aktivierte Add-ons im Bereich Apigee API Analytics-Add-ons verwalten angezeigt.

Informationen zum Deaktivieren des Add-ons finden Sie unter Add-on „Erweiterte API-Sicherheit“ deaktivieren.

Apigee in der Cloud Console

So deaktivieren Sie das Apigee API Analytics-Add-on in der Google Cloud Console:

  1. Öffnen Sie in der Console die Seite Apigee.

    Zu „Apigee“

  2. Wählen Sie das Projekt mit der „Pay as you go“-Organisation und Umgebungen aus, die Sie verwalten möchten.
  3. Wählen Sie Add-ons > Analysen aus, um die Seite Analytics-Add-on zu öffnen.
  4. Klicken Sie im Bereich Apigee API Analytics-Add-on verwalten das Kästchen für die Umgebung (oder Umgebungen) an, in denen Sie das Add-on deaktivieren möchten.
  5. Klicken Sie auf Ausgewählte auswählen.
  6. Wenn die Deaktivierung abgeschlossen ist, wird für die Status für jede Umgebung der Wert Deaktiviert angezeigt.

Apigee API

Geben Sie den folgenden Befehl ein, um das Apigee API Analytics-Add-on mithilfe der Apigee API zu deaktivieren: 

curl -X POST \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig:setAddonEnablement \
      -H "Authorization: Bearer $token" \
      -H "Content-type: application/json" \
      -d '{"analyticsEnabled":false}'

Wobei:

  • ORG_NAME ist der Name der „Pay as you go“-Organisation von Apigee, der Sie Analytics zu berechtigten Umgebungen hinzufügen möchten.
  • ENV_NAME ist der Name der Apigee-Umgebung, in der Sie das Apigee API Analytics-Add-on aktivieren möchten.

Add-on-Status für Apigee API Analytics in einer Umgebung aufrufen

Sie können den Status des Apigee API Analytics-Add-ons für eine Zwischen- oder umfassende Apigee-Umgebung mithilfe der Apigee-Benutzeroberfläche in der Google Cloud Console oder mithilfe der API prüfen, wie in den folgenden Abschnitten beschrieben.

Apigee in der Google Cloud Console

So rufen Sie den Status des Apigee API Analytics-Add-ons in einer Umgebung mit der Google Cloud Console auf:

  1. Öffnen Sie in der Console die Seite Apigee.

    Zu „Apigee“

  2. Wählen Sie das Projekt mit der „Pay as you go“-Organisation und Umgebungen aus, die Sie verwalten möchten.
  3. Wählen Sie Add-ons > Analysen aus, um die Seite Analytics-Add-on zu öffnen.
  4. Im Bereich Apigee API Analytics-Add-on verwalten wird eine Liste der Umgebungen angezeigt.
  5. In der Statusspalte können Sie sehen, ob das Add-on in jeder Zwischen- oder umfassenden Umgebung aktiviert oder deaktiviert ist. Basisumgebungen zeigen keinen der beiden Status an.

Apigee API

Geben Sie den folgenden Befehl ein, um den Status des Apigee API Analytics-Add-ons in einer Umgebung mit der Apigee API aufzurufen: 

curl -X GET \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig \
      -H "Authorization: Bearer $token" \
      -H "Content-type: application/json"

Wobei:

  • ORG_NAME ist der Name der „Pay as you go“-Organisation von Apigee.
  • ENV_NAME ist der Name der Apigee-Umgebung.

Die Antwort gibt ein analyticsConfig-Objekt zurück, das den aktuellen Status des Add-ons darstellt.

Apigee API Analytics-Daten verwalten

Sobald das Add-on für API-Analysen von Apigee für eine Umgebung aktiviert ist, werden Analysedaten für die Umgebung 14 Monate lang aufbewahrt. Sie können auf die Verlaufsanalysedaten der Umgebung über die API-Messwerte in der Console zugreifen, solange das Add-on aktiviert ist.

Wenn Sie das Add-on für Apigee API Analytics in einer Umgebung deaktivieren, werden die Analysedaten für die Umgebung nach 30 Tagen gelöscht. Wenn Sie das Add-on innerhalb von 30 Tagen nach der Deaktivierung in derselben Umgebung wieder aktivieren, können Sie innerhalb von 14 Monaten wieder auf die Analysedaten für die Umgebung zugreifen. Wenn das Add-on nach Ablauf der 30 Tage für die Umgebung wieder aktiviert wird, werden keine Daten wiederhergestellt.

Wenn Sie Analysedaten für eine Umgebung über die 14-monatige Aufbewahrungsdauer hinaus beibehalten möchten, empfehlen wir Ihnen, Ihre Daten an einem anderen Ort zu exportieren und zu speichern. Möglicherweise möchten Sie auch Ihre Analytics-Daten exportieren, bevor Sie das Add-on für Apigee API Analytics deaktivieren oder innerhalb des 30-tägigen Zeitfensters nach der Deaktivierung. Weitere Informationen finden Sie unter Daten aus Analytics exportieren.