Erstellen, Konfigurieren und Testen von Nutzungsplänen mit der API Gateway-Konsole

Vor der Erstellung eines Nutzungsplans sollten Sie sich vergewissern, dass die gewünschten API-Schlüssel konfiguriert sind. Weitere Informationen finden Sie unter Einrichten von API-Schlüsseln mit der API-Gateway-Konsole.

In diesem Abschnitt wird das Erstellen und Verwenden eines Nutzungsplans mithilfe der API Gateway-Konsole beschrieben.

Migrieren Ihrer API auf Standard-Nutzungspläne (falls erforderlich)

Wenn Sie API Gateway nach Einführung der Nutzungsplanfunktionalität (11. August 2016) verwenden, sind für Sie automatisch Nutzungspläne in allen unterstützten Regionen aktiviert.

Wenn Sie API Gateway vor diesem Datum eingeführt haben, müssen Sie möglicherweise auf Standardnutzungspläne migrieren. Die Option Nutzungspläne aktivieren wird angezeigt, bevor Sie zum ersten Mal Nutzungspläne in der ausgewählten Region verwenden. Durch die Aktivierung dieser Option werden Standardnutzungspläne für jede einzelne API-Stufe erstellt, der vorhandene API-Schlüssel zugeordnet sind. Im Standard-Nutzungsplan sind anfänglich keine Drossel- oder Kontingentlimits festgelegt, und die Zuordnungen zwischen den API-Schlüsseln und API-Stufen werden in die Nutzungspläne kopiert. Das API-Verhalten bleibt unverändert. Sie müssen jedoch die apiStages-Eigenschaft UsagePlan verwenden, um die angegebenen API-Stufenwerte (apiId und stage) mit den eingeschlossenen API-Schlüsseln zu verbinden (über UsagePlanKey), anstatt die stageKeys-Eigenschaft ApiKey zu verwenden.

Um zu überprüfen, ob Sie bereits auf Standardnutzungspläne migriert haben, führen Sie den CLI-Befehl get-account aus. In der Befehlsausgabe enthält die features-Liste den Eintrag "UsagePlans", wenn Nutzungspläne aktiviert sind.

Sie können Ihre APIs auch unter Verwendung der AWS CLI auf Standard-Nutzungsplänen migrieren. Dazu gehen Sie wie folgt vor:

So migrieren Sie mit der auf Standardnutzungsplän AWS CLI

1. Rufen Sie diesen CLI-Befehl auf: update-account.

2. Verwenden Sie für den cli-input-json-Parameter das folgende JSON-Konstrukt:

   [
       {
           "op": "add",
           "path": "/features",
           "value": "UsagePlans"
       }
   ]

Erstellen eines Nutzungsplans

Im folgenden Verfahren wird das Erstellen eines Nutzungsplans beschrieben.

So erstellen Sie einen Nutzungsplan

1. Klicken Sie im Hauptnavigationsbereich von Amazon API Gateway auf Usage Plans (Nutzungspläne) und auf Create (Erstellen).

2. Gehen Sie unter Create Usage Plan wie folgt vor:

   1. Geben Sie für Name einen Namen für Ihren Plan ein (beispielsweise Plan_A).

   2. Geben Sie für Beschreibung eine Beschreibung für Ihren Plan ein.

   3. Wählen Sie Enable throttling aus, legen Sie die Rate (beispielsweise 100) und Burst (zum Beispiel 200) fest.

   4. Wählen Sie Enable quota und legen Sie einen Wert (zum Beispiel 5000) für ein ausgewähltes Zeitintervall (beispielsweise Month) fest.

   5. Wählen Sie Next.

   

3. Gehen Sie zum Hinzufügen einer Stufe in dem Plan im Bereich Associated API Stages wie folgt vor:

   1. Wählen Sie Add API Stage.

   2. Wählen Sie eine API (zum Beispiel PetStore) aus der Dropdownliste API aus.

   3. Wählen Sie eine Stufe (beispielsweise Stage_1) aus der Dropdownliste Stage aus.

   4. Klicken Sie zum Speichern auf das Häkchen.

   

4. Um die Methoden-Drosselung zu konfigurieren, gehen Sie folgendermaßen vor:

   1. Wählen Sie Methoden-Drosselung konfigurieren aus.

   2. Wählen Sie Ressource/Methode hinzufügen aus.

   3. Wählen Sie aus dem Drop-Down-Menü Ressource die Ressource aus.

   4. Wählen Sie aus dem Drop-Down-Menü Methode die Methode aus.

   5. Legen Sie die Rate (Anforderungen pro Sekunde) (beispielsweise 100) und Burst (beispielsweise 200) fest.

   6. Klicken Sie zum Speichern auf das Häkchen.

   7. Klicken Sie auf Close.

5. Zum Hinzufügen eines Schlüssels zum Plan führen Sie in der Registerkarte API-Schlüssel die folgenden Schritte aus:

   1. Wählen Sie zur Verwendung eines vorhandenen Schlüssels Add API Key to Usage Plan.

   2. Geben Sie im Feld Name einen Namen für den Schlüssel ein, der hinzugefügt werden soll (zum Beispiel MyFirstKey).

   3. Klicken Sie zum Speichern auf das Häkchen.

   4. Wiederholen Sie bei Bedarf die oben beschriebenen Schritte, um diesem Nutzungsplan weitere vorhandene API-Schlüssel hinzuzufügen.

   
   Anmerkung

   Alternativ wählen Sie zum Erstellen eines neuen API-Schlüssels und Hinzufügen des Schlüssels zum Nutzungsplan API-Schlüssel erstellen und zum Nutzungsplan hinzufügen aus und befolgen Sie die Anweisungen.

   Anmerkung

   Ein API-Schlüssel kann mehreren Nutzungsplänen zugeordnet werden. Ein Nutzungsplan kann mehreren Stufen zugeordnet werden. Ein bestimmter API-Schlüssel kann jedoch nur einem Nutzungsplan für jede Stufe Ihres API zugeordnet werden.

6. Wählen Sie zum Fertigstellen des Nutzungsplans Done aus.

7. Falls dem Nutzungsplan weitere API-Stufen hinzugefügt werden sollen, wählen Sie Add API Stage aus und wiederholen Sie die zuvor beschriebenen Schritte.

Testen eines Nutzungsplans

Den Nutzungsplan können Sie mit einem AWS SDK, einer AWS CLI oder einem REST-API-Client wie "Postman" testen. Ein Beispiel für die Verwendung von Postman zum Testen des Nutzungsplans finden Sie unter Testen von Nutzungsplänen.

Verwalten eines Nutzungsplans

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 und erhöhen.

So überwachen Sie verwendete und verbleibende Kontingente

1. Klicken Sie im Hauptnavigationsbereich von API Gateway auf Usage Plans (Nutzungspläne).

2. Wählen Sie einen Nutzungsplan aus der Liste der Nutzungspläne aus.

3. Wählen Sie im angegebenen Plan API Keys aus.

4. Wählen Sie einen API-Schlüssel und dann Usage, um Subscriber's Traffic für den überwachten Plan anzuzeigen.

5. Wählen Sie optional Export ein From-Datum und ein To-Datum, JSON oder CSV für das Format der exportierten Daten und wählen Sie dann Export.

   Im folgenden Beispiel wird eine exportierte Datei angezeigt.

   {
     "thisPeriod": {
       "px1KW6...qBazOJH": [
         [
           0,
           5000
         ],
         [
           0,
           5000
         ],
         [
           0,
           10
         ]
       ]
     },
     "startDate": "2016-08-01",
     "endDate": "2016-08-03"
   }

   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.

So erhöhen Sie verbleibende Kontingente

1. Wiederholen Sie die Schritte 1 bis 3 des vorigen Verfahrens.

2. Wählen Sie im Bereich Nutzungsplan im Nutzungsplan-Fenster Extension (Erweiterung) aus.

3. Geben Sie eine Zahl für Anforderungskontingente des Typs Verbleibend an.

4. Wählen Sie Save (Speichern) aus.