Pflegen Sie einen Nutzungsplan für REST APIs in API Gateway

Im Rahmen der Nutzungsplanverwaltung werden verwendete und verbleibende Kontingente in einem bestimmten Zeitraum überwacht und die verbleibenden Kontingente gegebenenfalls um eine angegebene Menge erhöht. In den folgenden Verfahren wird beschrieben, wie Sie Kontingente überwachen.

AWS Management Console

So überwachen Sie verwendete und verbleibende Kontingente

1. Melden Sie sich bei der API Gateway Gateway-Konsole unter https://console.aws.amazon.com/apigatewayan.

2. Klicken Sie im Hauptnavigationsbereich von API Gateway auf Nutzungspläne.

3. Wählen Sie einen Nutzungsplan aus.

4. Wählen Sie die Registerkarte Zugeordnete API-Schlüssel, um die Anzahl der für den Zeitraum verbleibenden Anfragen für jeden Schlüssel anzuzeigen.

5. (Optional) Wählen Sie Nutzungsdaten exportieren und dann ein Startdatum und ein Enddatum aus. Wählen Sie dann JSON oder CSV als Exportdatenformat und anschließend Exportieren aus.

   Im folgenden Beispiel wird eine exportierte Datei angezeigt.

   {
       "px1KW6...qBazOJH": [
         [
           0,
           5000
         ],
         [
           0,
           5000
         ],
         [
           0,
           10
         ]
       ]
     }

   Die Nutzungsdaten im Beispiel geben die tägliche Nutzung eines API-Clients, der vom API-Schlüssel (px1KW6...qBazOJH) identifiziert wird, zwischen dem 1. August 2016 und dem 3. August 2016 an. In den täglichen Nutzungsdaten werden jeweils die verwendeten und die verbleibenden Kontingente angezeigt. In diesem Beispiel hat der Abonnent die ihm zugeordneten Kontingente gar nicht verwendet und der API-Besitzer oder Administrator hat das verbleibende Kontingent für den dritten Tag von 5.000 auf 10 gesenkt.

In den folgenden Verfahren wird beschrieben, wie Sie Kontingente ändern.

So erhöhen Sie verbleibende Kontingente

1. Melden Sie sich bei der API Gateway Gateway-Konsole unter https://console.aws.amazon.com/apigatewayan.

2. Klicken Sie im Hauptnavigationsbereich von API Gateway auf Nutzungspläne.

3. Wählen Sie einen Nutzungsplan aus.

4. Wählen Sie die Registerkarte Zugeordnete API-Schlüssel, um die Anzahl der für den Zeitraum verbleibenden Anfragen für jeden Schlüssel anzuzeigen.

5. Wählen Sie einen API-Schlüssel und dann Nutzungserweiterung gewähren aus.

6. Geben Sie eine Zahl für das Kontingent Verbleibende Anforderungen an. Sie können die Anzahl der Umbenennungsanfragen erhöhen oder die Anzahl der verbleibenden Anfragen für den Zeitraum Ihres Nutzungsplans verringern.

7. Wählen Sie Kontingent aktualisieren aus.

AWS CLI

In den folgenden update-usage-planBeispielen werden die Drosselungseinstellungen auf Methodenebene in einem Nutzungsplan hinzugefügt, entfernt oder geändert.

Anmerkung

Achten Sie darauf, us-east-1 auf den korrekten Regionswert für Ihre API zu ändern.

Um ein Ratenlimit zur Drosselung einer individuellen Ressource und Methode hinzuzufügen oder zu ersetzen:

aws apigateway --region us-east-1 update-usage-plan --usage-plan-id planId --patch-operations op="replace",path="/apiStages/apiId:stage/throttle/resourcePath/httpMethod/rateLimit",value="0.1"

Um ein Burst-Limit zur Drosselung einer individuellen Ressource und Methode hinzuzufügen oder zu ersetzen:

aws apigateway --region us-east-1 update-usage-plan --usage-plan-id planId --patch-operations op="replace",path="/apiStages/apiId:stage/throttle/resourcePath/httpMethod/burstLimit",value="1"

Um die Drosseleinstellungen auf Methodenebene für eine individuelle Ressource und Methode zu entfernen:

aws apigateway --region us-east-1 update-usage-plan --usage-plan-id planId --patch-operations op="remove",path="/apiStages/apiId:stage/throttle/resourcePath/httpMethod",value=""

Um alle Drosseleinstellungen einer API auf Methodenebene zu entfernen:

aws apigateway --region us-east-1 update-usage-plan --usage-plan-id planId --patch-operations op="remove",path="/apiStages/apiId:stage/throttle ",value=""

Hier sehen Sie ein Beispiel unter Verwendung der Pet Store-Beispiel-API:

aws apigateway --region us-east-1 update-usage-plan --usage-plan-id planId --patch-operations op="replace",path="/apiStages/apiId:stage/throttle",value='"{\"/pets/GET\":{\"rateLimit\":1.0,\"burstLimit\":1},\"//GET\":{\"rateLimit\":1.0,\"burstLimit\":1}}"'

REST API

Rufen Sie an usageplan:update, um einen Nutzungsplan zu verwalten.