Richten Sie eine Bühne für ein REST API API In-Gateway ein - APIAmazon-Gateway
Erstellen einer neuen StufeAktualisieren von StufeneinstellungenÜberschreiben der Einstellungen auf Stufenebene

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.

Richten Sie eine Bühne für ein REST API API In-Gateway ein

Eine Phase ist ein benannter Verweis auf eine Bereitstellung, bei der es sich um eine Momentaufnahme von handeltAPI. Sie verwenden eine Stufe, um eine bestimmte Bereitstellung zu verwalten und zu optimieren. Beispielsweise können Sie Stufeneinstellungen konfigurieren, um Zwischenspeicherung zu aktivieren, Anforderungsdrosselung anzupassen, Protokollierung zu konfigurieren, Stufenvariablen zu definieren oder ein Canary-Release für Tests anzufügen. Im folgenden Abschnitt wird gezeigt, wie Sie Ihre Phase erstellen und konfigurieren.

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 die API Gateway-Konsole verwenden, um eine neue Phase zu erstellen, oder Sie können bei der Bereitstellung eine vorhandene Phase auswählenAPI. Im Allgemeinen können Sie einer API Bereitstellung eine neue Phase hinzufügen, bevor Sie die API erneut bereitstellen. Gehen Sie folgendermaßen vor, um mithilfe der API Gateway-Konsole eine neue Phase zu erstellen:

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

  2. Wählen Sie ein RESTAPI.

  3. Wählen Sie im Hauptnavigationsbereich unter einem die Option Stufen ausAPI.

  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 unter Bereitstellung das Datum und die Uhrzeit der vorhandenen API Bereitstellung aus, die Sie dieser Phase 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.

Ändern Sie die Einstellungen der Phase

Nach einer erfolgreichen Bereitstellung eines API wird die Phase mit Standardeinstellungen gefüllt. Sie können die Konsole oder das API Gateway verwenden RESTAPI, um die Stage-Einstellungen, einschließlich API Caching und Logging, zu ändern. Die folgenden Schritte zeigen Ihnen, wie Sie dies mithilfe des Stage-Editors der API Gateway-Konsole tun können.

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

  2. Wählen Sie ein RESTAPI.

  3. Wählen Sie im Hauptnavigationsbereich unter einem die Option Stufen ausAPI.

  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 Phase zu aktivieren, aktivieren Sie APICache bereitstellen. Konfigurieren Sie dann das Standard-Caching auf Methodenebene, die Cachekapazität, die Cache-Daten verschlüsseln, Cache time-to-live (TTL) sowie alle Anforderungen für die Invalidierung des Caches pro Schlüssel.

    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 Cache-Einstellungen für REST APIs in API Gateway.

    Anmerkung

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

    Drosselungseinstellungen

    Um Drosselungsziele auf Stufenebene für alle damit verbundenen Methoden festzulegen, aktivieren Sie die Drosselung. API

    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 APIGateway-Kontingente für die Konfiguration und Ausführung eines 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 APIGateway-Kontingente für die Konfiguration und Ausführung eines 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 die Kosten zu kontrollieren oder den Zugriff auf eine zu blockieren. API Erwägen Sie AWS Budgetsden Einsatz zur Kostenüberwachung und Verwaltung AWS WAFAPIvon Anfragen.

    Firewall- und Zertifikatseinstellungen

    Um der Bühne ein AWS WAF Web ACL zuzuordnen, wählen Sie ein Web ACL aus der ACL Dropdownliste Web aus. Falls gewünscht, wählen Sie „APIAnfrage blockieren, wenn das Web ACL nicht bewertet werden kann“ (Fehlgeschlagen — 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 dieses API Gateways verknüpft sindAPI, wählen Sie im Abschnitt Protokolle und Ablaufverfolgung die Option Bearbeiten aus.

    Anmerkung

    Um CloudWatch Logs zu aktivieren, müssen Sie auch die IAM Rolle angeben, mit ARN der API Gateway im Namen Ihres Benutzers Informationen in CloudWatch Logs schreiben kann. Wählen Sie dazu im APIsHauptnavigationsbereich die Option Einstellungen aus. Geben Sie dann für die CloudWatch Protokollrolle den Namen ARN einer IAM Rolle ein.

    Für allgemeine Anwendungsszenarien könnte die IAM Rolle die verwaltete Richtlinie von anhängenAmazonAPIGatewayPushToCloudWatchLogs, die die folgende Erklärung zur Zugriffsrichtlinie 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 außerdem die folgende Vertrauensstellung 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 bei der Fehlerbehebung nützlich seinAPIs, kann jedoch dazu führen, dass sensible Daten protokolliert werden.

      Anmerkung

      Wir empfehlen, die vollständigen Anfrage- und Antwortprotokolle nicht für die Produktion zu verwendenAPIs.

  11. Wählen Sie Detaillierte Metriken aus, damit API Gateway einen Bericht über CloudWatch die API Metriken von API calls LatencyIntegration latency,400 errors, und erstellt500 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 API auf Stufe oder Stufe.

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

  13. Geben Sie als Ziel ARN für das Zugriffsprotokoll den ARN Wert einer Protokollgruppe oder eines Firehose-Streams 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. Um das AWS X-RayTracing für die API Phase zu aktivieren, wählen Sie X-Ray Tracing aus. Weitere Informationen finden Sie unter Verfolgen Sie Benutzeranfragen mit X-Ray in API Gateway an REST-APIs.

  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

Nachdem Sie die Einstellungen auf Stufenebene angepasst haben, können Sie sie für jede Methode überschreiben. API Bei einigen dieser Optionen können zusätzliche Gebühren für Sie anfallen. AWS-Konto

  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 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 Stufe oder auf API Stufe.

  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 Sie Anfragen an Ihre REST-APIs für einen besseren Durchsatz in API Gateway.

  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. Klicken Sie auf Speichern.