Einrichten einer Stufe mithilfe der API Gateway-Konsole

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

2. Wählen Sie eine REST-API aus.

3. Wählen Sie im Hauptnavigationsbereich unter APIs die Option Stages (Stufen).

4. Wählen Sie im Navigationsbereich Stages (Stufen) die Option Create stage (Stufe erstellen).

5. Geben Sie unter Stage name (Stufenname) einen Namen ein (z. B. prod).

   Anmerkung

   Phasennamen dürfen nur alphanumerische Zeichen sowie Binde- und Unterstriche enthalten. Die maximale Länge beträgt 128 Zeichen.

6. (Optional). Geben Sie unter Description (Beschreibung) eine kurze Beschreibung der Stufe ein.

7. Wählen Sie in der Dropdown-Liste Deployment (Bereitstellung) das Datum und die Uhrzeit der vorhandenen API-Bereitstellung aus, die Sie dieser Stufe zuordnen möchten.

8. Unter Zusätzliche Einstellungen können Sie zusätzliche Einstellungen für Ihre Stufe angeben.

9. Wählen Sie Create stage (Stufe erstellen) aus.

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

2. Wählen Sie eine REST-API aus.

3. Wählen Sie im Hauptnavigationsbereich unter APIs die Option Stages (Stufen).

4. Wählen Sie im Bereich Stages den Namen der Stufe aus.

5. Wählen Sie im Abschnitt Stage details (Stufendetails) die Option Edit (Bearbeiten) aus.

6. (Optional) Bearbeiten Sie die Beschreibung in Stufenbeschreibung.

7. Ändern Sie die folgenden Einstellungen in Zusätzliche Einstellungen:

   Cache-Einstellungen

   Um API-Caching für die Phase zu aktivieren, aktivieren Sie API-Cache bereitstellen. Konfigurieren Sie dann das Standard-Caching auf Methodenebene, die Cachekapazität, die Cache-Daten verschlüsseln, den Cache time-to-live (TTL) sowie alle Anforderungen für die Cache-Invalidierung pro Schlüssel.

   Das Caching ist erst aktiv, wenn Sie das standardmäßige Caching auf Methodenebene oder den Cache auf Methodenebene für eine bestimmte Methode aktivieren.

   Weitere Informationen zu Cache-Einstellungen finden Sie unter Aktivieren von API-Caching für verbesserte Reaktionsfähigkeit.

   Anmerkung

   Wenn Sie API-Caching für eine API-Phase aktivieren, wird Ihr AWS Konto möglicherweise für das API-Caching belastet. Caching kommt nicht für das kostenlose Kontingent in Frage. AWS

   Drosselungseinstellungen

   Aktivieren Sie die Option Drosselung zum Einrichten der Drosselungs-Targets auf Stufenebene für alle Methoden, die dieser API zugeordnet sind.

   Geben Sie für Rate einen Zielsatz ein. Dies ist die Rate in Anfragen pro Sekunde, mit der Token zum Token-Bucket hinzugefügt werden. Diese Rate auf Stufenebene darf nicht größer sein als die Rate auf Kontoebene, die unter API Gateway-Kontingente für die Konfiguration und Ausführung einer REST-API vorgegeben ist.

   Geben Sie für Burst eine Ziel-Burst-Rate ein. Die Burst-Rate ist die Kapazität des Token-Buckets. Dies ermöglicht mehr Anfragen für einen bestimmten Zeitraum als der Zielsatz. Diese Burst-Rate auf Stufenebene darf nicht größer sein als die Burst-Rate auf Kontoebene, die unter API Gateway-Kontingente für die Konfiguration und Ausführung einer REST-API angegeben ist.

   Anmerkung

   Drosselungsraten sind keine harten Grenzwerte und werden auf Best-Effort-Basis angewendet. In manchen Fällen können Kunden die von Ihnen festgelegten Ziele überschreiten. Verlassen Sie sich nicht auf die Drosselung, um Kosten zu kontrollieren oder den Zugriff auf eine API zu blockieren. Ziehen Sie es in Betracht, AWS Budgets zu verwenden, um Kosten zu überwachen und AWS WAF, um API-Anfragen zu verwalten.

   Firewall- und Zertifikatseinstellungen

   Um der Phase eine AWS WAF Web-ACL zuzuordnen, wählen Sie eine Web-ACL aus der Dropdownliste Web-ACL aus. Falls gewünscht, wählen Sie Block API Request if WebACL cannot be evaluated (Fail- Close) (API-Anforderung blockieren, wenn WebACL nicht ausgewertet werden kann (Fehler – Schließen)).

   Um ein Client-Zertifikat für Ihre Stufe auszuwählen, wählen Sie ein Zertifikat aus dem Dropdownmenü Client certificate (Client-Zertifikat) aus.

8. Wählen Sie Speichern.

9. Um Amazon CloudWatch Logs für alle Methoden zu aktivieren, die mit dieser Phase dieser API-Gateway-API verknüpft sind, wählen Sie im Abschnitt Logs and tracing die Option Bearbeiten.

   Anmerkung

   Um CloudWatch Logs zu aktivieren, müssen Sie auch den ARN einer IAM-Rolle angeben, die es API Gateway ermöglicht, im Namen Ihres Benutzers Informationen in CloudWatch Logs zu schreiben. Wählen Sie dazu Settings im Hauptnavigationsbereich APIs. Geben Sie dann für die CloudWatch Protokollrolle den ARN einer IAM-Rolle ein.

   In gängigen Anwendungsszenarien kann die IAM-Rolle beispielsweise die verwaltete Richtlinie von AmazonAPIGatewayPushToCloudWatchLogs anfügen, die die folgende Zugriffsrichtlinienanweisung enthält:

   {
       "Version": "2012-10-17",
       "Statement": [
           {
               "Effect": "Allow",
               "Action": [
                   "logs:CreateLogGroup",
                   "logs:CreateLogStream",
                   "logs:DescribeLogGroups",
                   "logs:DescribeLogStreams",
                   "logs:PutLogEvents",
                   "logs:GetLogEvents",
                   "logs:FilterLogEvents"
               ],
               "Resource": "*"
           }
       ]
   }

   Die IAM-Rolle muss zudem die folgende Vertrauensstellungsanweisung enthalten:

   {
     "Version": "2012-10-17",
     "Statement": [
       {
         "Sid": "",
         "Effect": "Allow",
         "Principal": {
           "Service": "apigateway.amazonaws.com"
         },
         "Action": "sts:AssumeRole"
       }
     ]
   }

   Weitere Informationen zu CloudWatch finden Sie im CloudWatch Amazon-Benutzerhandbuch.

10. Wählen Sie im Dropdownmenü Protokolle eine CloudWatch Protokollierungsebene aus. Die Protokollierungsebenen sind die folgenden:

    • Aus — Die Protokollierung ist für diese Phase nicht aktiviert.

    • Nur Fehler — Die Protokollierung ist nur für Fehler aktiviert.

    • Fehler und Informationsprotokolle — Die Protokollierung ist für alle Ereignisse aktiviert.

    • Vollständige Anfrage- und Antwortprotokolle — Die detaillierte Protokollierung ist für alle Ereignisse aktiviert. Dies kann zur Fehlerbehebung bei APIs hilfreich sein, kann aber dazu führen, dass sensible Daten protokolliert werden.

      Anmerkung

      Es wird empfohlen, Full Request and Response Logs (Vollständige Anforderungs- und Antwortprotokolle) nicht zu verwenden.

11. Wählen Sie Detaillierte Metriken aus, damit API Gateway über CloudWatch die API-Metriken von API calls LatencyIntegration latency,400 errors, und berichtet500 errors. Weitere Informationen zu CloudWatch finden Sie in den Abschnitten Grundlegende Überwachung und detaillierte Überwachung im CloudWatch Amazon-Benutzerhandbuch.

    Wichtig

    Ihr Konto wird für den Zugriff auf Metriken auf Methodenebene belastet, nicht jedoch für CloudWatch Metriken auf API- oder Stufenebene.

12. Aktivieren Sie die Benutzerdefinierte Zugriffsprotokollierung, um die Protokollierung für ein Ziel zuzulassen.

13. Geben Sie für Access Log Destination ARN den ARN einer Protokollgruppe oder eines Firehose ein.

    Das ARN-Format für Firehose istarn:aws:firehose:{region}:{account-id}:deliverystream/amazon-apigateway-{your-stream-name}. Der Name Ihres Firehose-Streams muss sein. amazon-apigateway-{your-stream-name}

14. Geben Sie unter Log Format (Protokollformat) ein Protokollformat ein. Weitere Informationen zu Beispielprotokollformaten finden Sie unter CloudWatch Protokollformate für API Gateway.

15. Wählen Sie zum Aktivieren der AWS X-Ray-Nachverfolgung für die API-Stufe die Option X-Ray tracing (X-Ray-Nachverfolgung). Weitere Informationen finden Sie unter Ablaufverfolgung von Benutzeranforderungen an REST-APIs mithilfe von X-Ray.

16. Wählen Sie Save Changes (Änderungen speichern). Stellen Sie Ihre API erneut bereit, damit die neuen Einstellungen wirksam werden.

So überschreiben Sie Einstellungen auf Stufenebene mithilfe der API Gateway-Konsole

1. Vergrößern Sie die Stufe im sekundären Navigationsbereich, um Methodenüberschreibungen zu konfigurieren und wählen Sie dann eine Methode aus.

   

2. Klicken Sie für Methodenüberschreibungen auf Bearbeiten.

3. Um CloudWatch Einstellungen auf Methodenebene zu aktivieren, wählen Sie unter CloudWatch Protokolle eine Protokollierungsebene aus.

4. Klicken Sie auf Detaillierte Metriken, um diese auf Methodenebene zu aktivieren. Ihrem Konto wird der Zugriff auf Metriken auf Methodenebene in Rechnung gestellt, nicht jedoch auf CloudWatch Metriken auf API- oder Stufenebene.

5. Klicken Sie auf Drosselung, um diese auf Methodenebene zu aktivieren. Geben Sie die entsprechenden Optionen auf Methodenebene ein. Weitere Informationen zur Drosselung finden Sie unter Drosseln der API-Anforderungen für einen besseren Durchsatz.

6. Um den Cache auf Methodenebene zu konfigurieren, wählen Sie Methoden-Cache aktivieren aus. Wenn Sie die Standardeinstellung für das Caching auf Methodenebene in den Stage-Details ändern, hat dies keine Auswirkungen auf diese Einstellung.

7. Wählen Sie Speichern.

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

2. Wählen Sie eine REST-API aus.

3. Klicken Sie im Hauptnavigationsbereich auf Stages (Stufen).

4. Wählen Sie im Bereich Stages (Stufen) die Stufe aus, die Sie löschen möchten, und klicken Sie dann unter Stage actions (Stufenaktionen) auf Delete stage (Stufe löschen).

5. Geben Sie bei der Aufforderung confirm ein und klicken Sie dann auf Delete (Löschen).