Erweiterte API-Vorgänge

Diese Seite gilt für Apigee und Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

Mit Advanced API Operations (AAPI Ops) von Apigee können Sie dafür sorgen, dass Ihre APIs wie gewünscht funktionieren. AAPI Ops erkennt ungewöhnliche Muster im API-Traffic automatisch. Diese werden als Anomalien bezeichnet, z. B. Spitzen bei der Latenz oder der Fehlerrate. Anomalien können auf Probleme mit der API-Leistung hindeuten. Wenn AAPI Ops eine Anomalie erkennt, können Sie sich im Dashboard für Anomalieereignisse seine Details ansehen und entsprechende Maßnahmen ergreifen, um das normale API-Verhalten wiederherzustellen.

Mit AAPI Ops können Sie:

  • Anomalien erkennen: AAPI Ops meldet ungewöhnliche API-Ereignisse (Anomalien) im Dashboard für Anomalieereignisse.
  • Anomalien untersuchen: Wenn AAPI Ops eine Anomalie feststellt, können Sie ermitteln, wo und wann der Vorfall aufgetreten ist und was ihn ausgelöst hat. So können Sie das Problem schnell beheben.
  • Anomaliebenachrichtigungen erstellen und Benachrichtigungen einrichten, damit Apigee Ihnen bei einem Vorfall eine Nachricht sendet. Sie können Benachrichtigungen über mehrere Kanäle erhalten, darunter E-Mail, Slack, PagerDuty oder Webhooks.

Weitere Informationen zu Anomalien finden Sie unter Anomalieerkennung.

Erforderliche Rollen für AAPI Ops

Um AAPI Ops zu verwenden, müssen Sie die folgenden Rollen zuweisen:

  • roles/apigee.readOnlyAdmin
  • roles/logging.viewer
  • roles/monitoring.viewer

Weitere Informationen finden Sie unter Apigee-Rollen.

AAPI Ops in einer Organisation aktivieren

Um AAPI Ops zu verwenden, müssen Sie es in Ihrer Organisation aktivieren. Rufen Sie vorher ein OAuth 2.0-Zugriffstoken ab. Sie können dann AAPI Ops mit einem API-Aufruf aktivieren, der das Zugriffstoken übergibt.

Aktuelle Add-on-Konfiguration anzeigen

Bevor Sie AAPI Ops aktivieren, prüfen Sie, ob es bereits aktiviert ist. Führen Sie dazu den folgenden API-Aufruf aus:

curl "https://apigee.googleapis.com/v1/organizations/YOUR_ORG" \
  -X GET \
  -H "Content-type: application/json" \
  -H "Authorization: Bearer $TOKEN"

Dabei ist YOUR_ORG der Name Ihrer Organisation und $TOKEN die Umgebungsvariable für ein OAuth-Zugriffstoken. Dadurch werden grundlegende Informationen zu Ihrer Organisation zurückgegeben, darunter ein Abschnitt für Apigee-Add-ons, der mit der folgenden Zeile beginnt:

"addonsConfig": {

Prüfen Sie, ob dieser Abschnitt einen Eintrag enthält, der mit "advancedApiOpsConfig" beginnt, wie im folgenden Beispiel:

"advancedApiOpsConfig": {
          "enabled": "true"
      }

Wenn dieser Eintrag vorhanden ist, ist AAPI Ops bereits in der Organisation aktiviert. Wenn nicht, müssen Sie sie wie unten beschrieben aktivieren.

AAPI Ops aktivieren

Zum Aktivieren von AAPI Opps in der Organisation mit der Standardkonfiguration senden Sie eine POST-Anfrage wie die folgende.

curl "https://apigee.googleapis.com/v1/organizations/ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "advancedApiOpsConfig": {
          "enabled": "true"
      }
      <Current add-ons configuration>
    }
  }'

Dabei ist <Current add-ons configuration> die aktuelle Add-on-Konfiguration. Sie finden die aktuelle Add-on-Konfiguration in der Antwort auf den Aufruf zum Anzeigen der aktuellen Add-on-Konfiguration. Wenn die aktuelle Add-on-Konfiguration beispielsweise

"addonsConfig": {
    "integrationConfig": {
        "enabled":"true"
     },
    "monetizationConfig": {
        "enabled":"true"
     }
  },

der Befehl zur Aktivierung von AAPI Ops wäre 

curl "https://apigee.googleapis.com/v1/organizations/YOUR_ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "advancedApiOpsConfig": {
          "enabled": "true"
      },
    "integrationConfig": {
          "enabled": "true"
      },
    "monetizationConfig": {
          "enabled": "true"
      }
    }
  }'

Nachdem Sie die Anfrage gesendet haben, wird eine Antwort wie diese angezeigt:

{
  "name": "organizations/apigee-docs-d/operations/0718a945-76e0-4393-a456-f9929603b32c",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/apigee-docs-d",
    "state": "IN_PROGRESS"
  }
}

AAPI Ops in Ihrer Organisation deaktivieren

Wenn Sie die AAPI Ops für Ihre Organisation deaktivieren müssen, können Sie dazu eine POST-Anfrage senden und die Add-on-Konfiguration im Anfragetext übergeben, wie unten gezeigt.

curl "https://apigee.googleapis.com/v1/organizations/$ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "advancedApiOpsConfig`": {
          "enabled": "false"
      }
     <Include current add-ons configuration>
    }
  }'

Das folgende Beispiel enthält eine Antwort, die zeigt, dass der Vorgang läuft: 

{
  "name": "organizations/$ORG/operations/06274ffb-8940-41da-836d-781cba190437",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/$ORG",
    "state": "IN_PROGRESS"
  }
}

Weitere Informationen finden Sie unter Organization Add-ons API konfigurieren.