Oracle Cloud Infrastructure - Dokumentation

Nutzungspläne zur Verwaltung des Abonnentenzugriffs auf APIs definieren

Erfahren Sie, wie Sie Nutzungspläne zur Verwaltung des Abonnentenzugriffs auf APIs mit API Gateway definieren.

Nachdem Sie ein API-Gateway erstellt und eine oder mehrere APIs darauf bereitgestellt haben, möchten API-Planmanager in der Regel:

  • API-Consumer und API-Clients, die auf APIs zugreifen, überwachen und verwalten
  • verschiedene Zugriffsebenen für verschiedene Kunden einrichten

Als API-Planmanager können Sie den API-Zugriff überwachen und verwalten, indem Sie Nutzungspläne und Abonnenten erstellen. Siehe Nutzungspläne und Berechtigungen, Abonnenten und Client-Token.

Sie können den API-Zugriff Tariflimits und Quoten unterliegen, die auf bestimmte Kundenanforderungen zugeschnitten sind, sodass Sie verschiedene Zugriffsebenen für verschiedene Kunden einrichten können. Beispiel: Sie möchten drei Zugriffsebenen für Ihre APIs anbieten: eine Gold-Ebene, die bis zu 1000 Anforderungen pro Stunde zulässt, eine Silver-Ebene, die bis zu 500 Anforderungen pro Stunde zulässt, und eine Bronze-Ebene, die bis zu 100 Anforderungen pro Stunde zulässt. Möglicherweise möchten Sie auch ein allgemeines Ratenlimit von 10 Anforderungen pro Sekunde für jeden Kunden festlegen, um sicherzustellen, dass die starke Nutzung durch einen Kunden andere Kunden nicht beeinträchtigt.

Um einen Nutzungsplan und einen Subscriber für die Verwaltung des Zugriffs auf eine API einzurichten, müssen Sie:

  • Ein API-Deployment für die Aufnahme in einen Nutzungsplan qualifizieren.

    Damit ein API-Deployment in einen Nutzungsplan aufgenommen werden kann, müssen Sie den Speicherort eines Clienttokens angeben, das in einer Anforderung übergeben wird. Nachdem das API-Deployment in einen Nutzungsplan aufgenommen wurde, müssen Anforderungen von abonnierten API-Clients das Clienttoken an diesem Speicherort enthalten, um auf das API-Deployment zugreifen zu können. Sie geben den Clienttokenspeicherort in einer Anforderungs-Policy für globale Nutzungspläne für alle Routen in einer API-Deployment-Spezifikation an. Siehe API-Deployment für die Aufnahme in einen Nutzungsplan qualifizieren.

  • Erstellen Sie einen Nutzungsplan mit einer Berechtigung, die das API-Deployment als Ziel angibt.

    Nachdem Sie das API-Deployment zur Aufnahme berechtigt haben, können Sie eine Nutzungsplandefinition erstellen, die eine Berechtigung enthält, die das API-Deployment als Ziel angibt und optional ein Ratenlimit und eine Quota angibt. Wenn die Anzahl der Anforderungen in einem bestimmten Zeitraum eine Anforderungsquote überschreitet, können Sie angeben, ob Anforderungen weiterhin zulässig sind oder abgelehnt werden. Wenn eine Anforderung abgelehnt wird, weil die Quota überschritten wurde, gibt der Antwortheader an, wann die Anforderung wiederholt werden kann. Siehe Nutzungsplan erstellen.

  • Erstellen Sie eine Subscriber-Definition, die den Nutzungsplan angibt.

    Nachdem Sie einen Nutzungsplan erstellt haben, können Sie eine oder mehrere Subscriber-Definitionen für Ihre Kunden (API-Consumer) und deren API-Clients erstellen. Eine Subscriber-Definition umfasst Clientnamen und Clienttoken zur eindeutigen Identifizierung von API-Clients und gibt den Nutzungsplan an, der ihnen Zugriff auf Ihre APIs gewährt. Siehe Abonnenten erstellen.

Nachdem Sie einen Nutzungsplan eingerichtet haben, können Sie Metriken verwenden, um Nutzungsmuster zu verstehen und Alarmnachrichten zu senden, wenn Ratenlimits und Quoten erreicht und überschritten werden. Siehe API-Gatewaymetriken.