Einrichten einer Stufe mithilfe der API Gateway-Konsole - Amazon API Gateway

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Einrichten einer Stufe mithilfe der API Gateway-Konsole

Erstellen einer neuen Stufe

Nach der ersten Bereitstellung können Sie weitere Stufen hinzufügen und sie mit vorhandenen Bereitstellungen verknüpfen. Sie können über die API Gateway-Konsole eine neue Stufe erstellen oder während der Bereitstellung einer API eine vorhandene Stufe auswählen. Im Allgemeinen fügen Sie eine neue Stufe zu einer API-Bereitstellung vor der erneuten Bereitstellung der API hinzu. Gehen Sie folgendermaßen vor, um mithilfe der API Gateway-Konsole eine neue Stufe zu erstellen:

  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.

Aktualisieren von Stufeneinstellungen

Nach der erfolgreichen Bereitstellung einer API wird die Stufe mit Standardeinstellungen gefüllt. Sie können die Konsole oder die API Gateway-REST-API verwenden, um die Stufeneinstellungen zu ändern, einschließlich des API-Cachings und der Protokollierung. Im Folgenden wird gezeigt, wie Sie dies mithilfe des Stufen-Editor der API Gateway-Konsole durchführen.

Aktualisieren der Stufeneinstellungen mithilfe der API Gateway-Konsole

Diese Schritte gehen davon aus, dass Sie die API bereits in einer Stufe bereitgestellt haben.

  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 das API-Caching für die Stufe zu aktivieren, aktivieren Sie API-Cache bereitstellen . Konfigurieren Sie dann das Standard-Caching auf Methodenebene, die Cache-Kapazität, die Encrypt-Cache-Daten, 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 Standard-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 das API-Caching für eine API-Stufe aktivieren, wird Ihrem AWS Konto möglicherweise das API-Caching in Rechnung gestellt. Caching ist nicht für das AWS kostenlose Kontingent für berechtigt.

    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 eine - AWS WAF Web-ACL mit der Stufe zu verknüpfen, wählen Sie eine Web-ACL aus der Dropdown-Liste 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 dieser Stufe dieser API Gateway-API zugeordnet sind, wählen Sie im Abschnitt Protokolle und Ablaufverfolgung die Option Bearbeiten aus.

    Anmerkung

    Um CloudWatch Protokolle 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 Protokolle zu schreiben. Wählen Sie dazu Settings im Hauptnavigationsbereich APIs. Geben Sie dann für CloudWatch die 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 CloudWatchfinden Sie im Amazon CloudWatch -Benutzerhandbuch.

  10. Wählen Sie eine der folgenden Optionen für die Protokollebene aus:

    • Um nur Einträge auf Fehlerebene in CloudWatch Protokolle zu schreiben, wählen Sie Nur Fehler aus.

    • Um nur Einträge auf Fehlerebene in - CloudWatch Protokolle zu schreiben, oder wählen Sie Fehler und Info-Protokolle aus, um alle FEHLERereignisse sowie zusätzliche Informationsereignisse einzubeziehen.

    • Zur Protokollierung der vollständigen Informationen zu API-Aufrufanforderungen und -reaktionen wählen Sie Full request and response logs (Vollständige Anforderungs- und Antwortprotokolle). Sensitive Daten werden nur protokolliert, wenn die Option Log full requests and responses data (Vollständige Anfragen- und Antwortendaten protokollieren) ausgewählt ist.

  11. Um API Gateway an CloudWatch die API-Metriken von API calls, Latency, Integration latency400 errors, und melden zu lassen500 errors, wählen Sie Detaillierte Metriken aus. Weitere Informationen zu CloudWatchfinden Sie im Amazon CloudWatch -Benutzerhandbuch.

    Wichtig

    Ihrem Konto wird der Zugriff auf CloudWatch Metriken auf Methodenebene in Rechnung gestellt, nicht jedoch die Metriken auf API- oder Stufenebene.

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

  13. Geben Sie für Zugriffsprotokollziel-ARN den ARN einer Protokollgruppe oder eines Firehose-Streams ein.

    Das ARN-Format für Firehose ist arn:aws:firehose:{region}:{account-id}:deliverystream/amazon-apigateway-{your-stream-name}. Der Name Ihres Firehose-Streams muss lautenamazon-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.

Überschreiben der Einstellungen auf Stufenebene

Die folgenden aktivierten Einstellungen auf Stufenebene können überschrieben werden. Einige dieser Optionen können zu zusätzlichen Gebühren für Ihr führen AWS-Konto.

Einstellungen auf Stufenebene mithilfe der API Gateway-Konsole überschreiben

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.

    
          Vergrößern der Stufe im sekundären Navigationsbereich und Auswahl einer Methode.
  2. Klicken Sie für Methodenüberschreibungen auf Bearbeiten.

  3. Um die CloudWatch Einstellungen auf Methodenebene zu aktivieren, wählen Sie für CloudWatch Protokolle eine Protokollierungsebene aus.

  4. Klicken Sie auf Detaillierte Metriken, um diese auf Methodenebene zu aktivieren. Ihrem Konto wird der Zugriff auf CloudWatch Metriken auf Methodenebene in Rechnung gestellt, nicht jedoch die 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 Caching-Standardeinstellung auf Methodenebene in den Stufendetails ändern, hat dies keinen Einfluss auf diese Einstellung.

  7. Wählen Sie Speichern.

Löschen einer Stufe

Wenn Sie eine Stufe nicht mehr benötigen, können Sie diese löschen, um Kosten für ungenutzte Ressourcen zu vermeiden. In den folgenden Schritten wird gezeigt, wie Sie die API Gateway-Konsole zum Löschen einer Stufe verwenden.

Warnung

Das Löschen einer Stufe kann dazu führen, dass ein Teil der oder die gesamte zugehörige API nicht mehr von API-Aufrufern verwendet werden kann. Das Löschen einer Stufe kann nicht rückgängig gemacht werden. Sie können die Stufe jedoch neu erstellen und derselben Bereitstellung zuordnen.

Löschen 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. 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).