Wählen Sie Ihre Cookie-Einstellungen aus

Wir verwenden essentielle Cookies und ähnliche Tools, die für die Bereitstellung unserer Website und Services erforderlich sind. Wir verwenden Performance-Cookies, um anonyme Statistiken zu sammeln, damit wir verstehen können, wie Kunden unsere Website nutzen, und Verbesserungen vornehmen können. Essentielle Cookies können nicht deaktiviert werden, aber Sie können auf „Anpassen“ oder „Ablehnen“ klicken, um Performance-Cookies abzulehnen.

Wenn Sie damit einverstanden sind, verwenden AWS und zugelassene Drittanbieter auch Cookies, um nützliche Features der Website bereitzustellen, Ihre Präferenzen zu speichern und relevante Inhalte, einschließlich relevanter Werbung, anzuzeigen. Um alle nicht notwendigen Cookies zu akzeptieren oder abzulehnen, klicken Sie auf „Akzeptieren“ oder „Ablehnen“. Um detailliertere Entscheidungen zu treffen, klicken Sie auf „Anpassen“.

Cache-Einstellungen für REST-APIs in API Gateway

Fokusmodus
Cache-Einstellungen für REST-APIs in API Gateway - Amazon API Gateway

Sie können API-Caching in Amazon API Gateway aktivieren, um die Antworten Ihres Endpunkts im Cache zu speichern. Mit Caching können Sie die Anzahl der an Ihren Endpunkt gemachten Aufrufe verringern und die Latenz der Anforderungen an Ihre API verbessern.

Wenn Sie das Caching für eine Stufe aktivieren, speichert API Gateway die Antworten von Ihrem Endpunkt für eine bestimmte Time-to-Live-Periode (TTL) in Sekunden. Anschließend beantwortet API Gateway die Anfrage, indem es die Endpunkt-Antwort aus dem Cache ausliest, anstatt eine Anfrage an Ihren Endpunkt zu senden. Der Standard-TTL-Wert für API-Caching ist 300 Sekunden. Die maximale TTL-Wert ist 3.600 Sekunden. TTL = 0 bedeutet, dass die Zwischenspeicherung deaktiviert ist.

Anmerkung

Caching ist die sinnvollste Tätigkeit. Mit den Metriken „CacheHitCount„ und „CacheMissCount“ in Amazon CloudWatch können Sie Anforderungen überwachen, die API Gateway aus dem API-Cache bedient.

Die maximale Größe einer Antwort, die zwischengespeichert werden kann, ist 1 048 576 Bytes. Die Cache-Datenverschlüsselung kann die Größe der Antwort erhöhen, wenn sie zwischengespeichert wird.

Dies ist ein HIPAA-berechtigter Service. Weitere Informationen zu AWS, dem Health Insurance Portability and Accountability Act of 1996 (HIPAA) und die Verwendung von AWS-Services zur Verarbeitung, Speicherung und Übertragung geschützter Gesundheitsinformationen (PHI) finden Sie in der HIPAA-Übersicht.

Wichtig

Wenn Sie das Caching für eine Stufe aktivieren, wird standardmäßig nur die Zwischenspeicherung von GET-Methoden aktiviert. Dies hilft, die Sicherheit und die Verfügbarkeit Ihrer API zu gewährleisten. Sie können das Caching für andere Methoden aktivieren, indem Sie die Methodeneinstellungen überschreiben.

Wichtig

Caching wird basierend auf der von Ihnen ausgewählten Cache-Größe nach Stunden berechnet. Caching ist für das kostenlose AWS-Kontingent nicht zulässig. Weitere Informationen finden Sie unter API-Gateway-Preise.

Caching von Amazon API Gateway aktivieren

In API Gateway können Sie das Caching für eine bestimmte Stufe aktivieren.

Wenn Sie Caching aktivieren, müssen Sie eine Cache-Kapazität auswählen. Im Allgemeinen bietet eine größere Kapazität eine bessere Leistung, kostet aber auch mehr. Unterstützte Cache-Größen finden Sie unter CacheClusterSize in der API-Gateway-API-Referenz.

API Gateway ermöglicht das Caching durch die Erstellung einer dedizierten Cache-Instance. Dieser Vorgang kann bis zu 4 Minuten dauern.

API Gateway ändert die Caching-Kapazität durch Löschen der vorhandenen Cache-Instance und Erstellen einen neuen mit einer geänderten Kapazität. Alle Daten im Cache werden gelöscht.

Anmerkung

Die Cache-Kapazität wirkt sich auf die CPU- und Netzwerkbandbreite der Cache-Instance aus. Infolgedessen kann sich die Cache-Kapazität auf die Performance Ihres Caches auswirken.

API Gateway empfiehlt, dass Sie einen 10-Minuten-Belastungstest durchführen, um zu überprüfen, ob Ihre Cache-Kapazität für Ihre Arbeitslast geeignet ist. Stellen Sie sicher, dass der Verkehr während des Lasttests den Produktionsverkehr widerspiegelt. Dazu gehören zum Beispiel Ramp Up, konstanter Verkehr und Verkehrsspitzen. Der Lasttest sollte Antworten enthalten, die aus dem Cache bereitgestellt werden können, sowie eindeutige Antworten, die dem Cache Elemente hinzufügen. Überwachen Sie die Latenz-, 4xx-, 5xx-, Cache-Hit- und Cache-Fehl-Metriken während des Belastungstests. Passen Sie Ihre Cache-Kapazität basierend auf diesen Metriken nach Bedarf an. Weitere Informationen zu Lasttests finden Sie unter Wie wähle ich die beste Kapazität für den API-Gateway-Cache aus, um zu vermeiden, dass ein Ratenlimit erreicht wird?.

In der API-Gateway-Konsole konfigurieren Sie das Caching auf der Stages-Seite. Sie stellen den Stage-Cache bereit und legen eine Standard-Cache-Einstellung auf Methodenebene fest. Wenn Sie den Standard-Cache auf Methodenebene aktivieren, wird die Zwischenspeicherung auf Methodenebene für alle GET-Methoden der Stufe aktiviert, es sei denn, es wurde eine Methodenüberschreibung konfiguriert. Alle zusätzlichen GET-Methoden, die Sie in dieser Stufe bereitstellen, verfügen über einen Cache auf Methodenebene. Sie können Methodenüberschreibungen verwenden, um die Caching-Einstellungen auf Methodenebene für bestimmte Methoden Ihrer Stufe zu konfigurieren. Weitere Informationen zu Methodenüberschreibungen finden Sie unter Caching auf API-Gateway-Stufenebene für das Caching auf Methodenebene überschreiben.

So konfigurieren Sie API-Caching für eine bestimmte Stufe:
  1. Melden Sie sich bei der API Gateway-Konsole unter https://console.aws.amazon.com/apigateway an.

  2. Wählen Sie Stages.

  3. Wählen Sie in der API-Liste Stages den Namen der Stufe aus.

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

  5. Aktivieren Sie unter Zusätzliche Einstellungen aktivieren Sie API-Cache bereitstellen für Zugriff auf Cache-Einstellungen.

    Dadurch wird ein Cache-Cluster für Ihre Stufe bereitgestellt.

  6. Aktivieren Sie Standard-Caching auf Methodenebene um für die Ebene Caching zuzulassen.

    Dadurch wird das Caching auf Methodenebene für alle GET-Methoden dieser Stufe aktiviert. Alle zusätzlichen GET-Methoden, die Sie in dieser Stufe bereitstellen, werden dann über einen Cache auf Methodenebene verfügen.

    Anmerkung

    Wenn bereits eine Einstellung für einen Cache auf Methodenebene vorhanden ist, wirkt sich eine Änderung des Standard-Cache auf Methodenebene nicht auf diese Einstellung aus.

    Aktivieren Sie den Provision-API-Cache und den Standard-Cache auf Methodenebene.
  7. Wählen Sie Änderungen speichern.

Anmerkung

Das API Gateway benötigt etwa 4 Minuten für das Erstellen und Löschen eines Caches.

Bei Erstellung eines Cache springt der Cache-Cluster-Wert von Create in progress auf Active. Nach vollständiger Löschung des Cache springt der Cache-Cluster-Wert von Delete in progress auf Inactive.

Wenn Sie das Caching auf Methodenebene für alle Methoden in Ihrer Stufe aktivieren, springt der Wert für Standard-Cache auf Methodenebene auf Active. Wenn Sie das Caching auf Methodenebene für alle Methoden in Ihrer Stufe deaktivieren, springt der Wert für Standard-Cache auf Methodenebene auf Inactive. Wenn bereits eine Einstellung für Standard-Cache auf Methodenebene vorhanden ist, wirkt sich ein Statusänderung des Cache nicht auf diese Einstellung aus.

Wenn Sie das Caching in den Cache-Einstellungen einer Stufe aktivieren, werden nur GET-Methoden zwischengespeichert. Um die Sicherheit und Verfügbarkeit Ihrer API zu gewährleisten, empfehlen wir Ihnen, diese Einstellung nicht zu ändern. Sie können das Caching aber auch für andere Methoden aktivieren, indem Sie die Methodeneinstellungen überschreiben.

Wenn Sie sich vergewissern möchten, ob die Zwischenspeicherung wie erwartet funktioniert, haben Sie zwei allgemeine Optionen:

  • Prüfen Sie die CloudWatch-Metriken CacheHitCount und CacheMissCount für Ihre API und Ihre Stufe.

  • Setzen Sie einen Zeitstempel in der Antwort.

Anmerkung

Sie sollten nicht den X-Cache-Header aus der CloudFront-Antwort verwenden, um festzustellen, ob Ihre API von Ihrer API Gateway-Cache-Instance aus bedient wird.

Caching auf API-Gateway-Stufenebene für das Caching auf Methodenebene überschreiben

Sie können Cache-Einstellungen auf Stufenebene überschreiben, indem Sie das Caching für eine bestimmte Methode aktivieren oder deaktivieren. Sie können außerdem auch den TTL-Zeitraum ändern oder die Verschlüsselung für zwischengespeicherte Antworten ein- oder ausschalten.

Wenn Sie die Einstellung für Standard-Caching auf Methodenebene in den Stufendetails ändern, hat dies keine Auswirkungen auf die Cache-Einstellungen auf Methodenebene, für die Überschreibungen konfiguriert sind.

Wenn Sie davon ausgehen, dass eine zwischengespeicherte Methode sensible Daten in ihren Antworten erhält, wählen Sie in den Cache-Einstellungen die Option Encrypt cache data aus.

So konfigurieren Sie API-Caching für einzelne Methoden mithilfe der Konsole:
  1. Melden Sie sich bei der API Gateway-Konsole unter https://console.aws.amazon.com/apigateway an.

  2. Wählen Sie die API.

  3. Wählen Sie Stages.

  4. Erweitern Sie in der Liste Stufen für die API die Stufe, und wählen Sie eine Methode in der API aus.

  5. Wählen Sie im Abschnitt Methodenüberschreibungen die Option Bearbeiten aus.

  6. Aktivieren oder deaktivieren Sie im Abschnitt Methodeneinstellungen die Option Methoden-Cache aktivieren oder deaktivieren Sie die gewünschten Optionen.

    Anmerkung

    Das Caching ist erst dann aktiv, wenn Sie einen Cache-Cluster für Ihre Stufe bereitstellen.

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

Verwenden der Methoden-/Integrationsparameter als Cache-Schlüssel, um zwischengespeicherte Antworten zu indizieren

Sie können eine Methode oder Integrationsparameter als Cache-Schlüssel verwenden, um zwischengespeicherte Antworten zu indizieren. Dazu gehören benutzerdefinierte Header, URL-Pfade oder Abfragezeichenfolgen. Sie können ein paar oder alle dieser Parameter als Cache-Schlüssel festlegen - es muss jedoch mindestens ein Wert vorgegeben werden. Wenn ein Cache-Schlüssel vorhanden ist, speichert API Gateway die Antworten der einzelnen Schlüsselwerte separat im Cache; dasselbe geschieht wenn kein Cache-Schlüssel vorliegt.

Anmerkung

Cache-Schlüssel sind beim Einrichten von Caching für eine Ressource erforderlich.

Angenommen, Sie haben eine Anforderung im folgenden Format:

GET /users?type=... HTTP/1.1 host: example.com ...

In dieser Anforderung kann type den Wert admin oder regular annehmen. Wenn Sie den type-Parameter als Teil des Cache-Schlüssels einbinden, werden die Antworten aus GET /users?type=admin getrennt von denen aus GET /users?type=regular zwischengespeichert.

Wenn eine Methode oder Integrationsanforderung mehr als einen Parameter annimmt, können Sie einige oder alle dieser Parameter einschließen, um den Cache-Schlüssel zu erstellen. Beispielsweise können Sie für die folgende Anforderung nur den type-Parameter in den Cache-Schlüssel einschließen, in der aufgelisteten Reihenfolge innerhalb eines TTL-Zeitraums:

GET /users?type=admin&department=A HTTP/1.1 host: example.com ...

Die Antwort von dieser Anforderung wird im Cache gespeichert und verwendet, um die folgende Anforderung zu bedienen:

GET /users?type=admin&department=B HTTP/1.1 host: example.com ...

Um einen Methoden- oder Integrationsanforderungsparameter als Teil eines Cache-Schlüssels in die API Gateway-Konsole aufzunehmen, wählen Sie Caching, nachdem Sie den Parameter hinzugefügt haben.

Einschließen von Methoden- oder Integrationsparametern als Cache-Schlüssel, um eine zwischengespeicherte Antwort zu indizieren

API-Stufen-Cache in API Gateway leeren

Wenn API-Zwischenspeicherung aktiviert ist, können Sie den Cache Ihrer API-Stufe löschen, um sicherzustellen, dass die Clients Ihrer API die neuesten Antworten von Ihren Integrationsendpunkten erhalten.

Wenn Sie den API-Stufen-Cache leeren möchten, wählen Sie das Menü Stufenaktionen und dann Stufen-Cache leeren aus.

Anmerkung

Nachdem der Cache gelöscht wurde, werden Antworten aus dem Integrationsendpunkt bedient, bis der Cache wieder aufgebaut ist. Während dieses Zeitraums kann sich die Anzahl der Anforderungen an den Integrationsendpunkt erhöhen. Dadurch kann sich die Gesamt-Latenz Ihrer API zeitweilig erhöhen.

API Gateway-Cache-Eintrag ungültig machen

Ein Client Ihrer API kann einen vorhandenen Cache-Eintrag entwerten und ihn vom Integrationsendpunkt für einzelne Anforderungen neu laden. Der Client muss eine Anforderung senden, die den Header Cache-Control: max-age=0 enthält. Der Client erhält die Antwort direkt vom Integrationsendpunkt anstelle des Zwischenspeichers, wenn der Client hierfür eine entsprechende Berechtigung hat. Dies ersetzt den vorhandenen Cache-Eintrag durch die neue Antwort, die vom Integrationsendpunkt abgerufen wird.

Um einem Aufrufer eine Berechtigung zu erteilen, fügen Sie an die IAM-Ausführungsrolle für den Client eine Richtlinie im folgenden Format an.

Anmerkung

Die kontoübergreifende Cache-Invalidierung wird nicht unterstützt.

{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "execute-api:InvalidateCache" ], "Resource": [ "arn:aws:execute-api:region:account-id:api-id/stage-name/GET/resource-path-specifier" ] } ] }

Diese Richtlinie erlaubt es dem API Gateway-Ausführungsdienst, den Cache für Anfragen zur angegebenen Ressource (oder den angegebenen Ressourcen) ungültig zu machen. Um eine Gruppe zum Ziel gesetzter Ressourcen anzugeben, verwenden Sie ein Platzhalterzeichen (*) für account-id, api-id und andere Angaben im ARN-Wert von Resource. Weitere Informationen über das Festlegen von Berechtigungen für den API Gateway-Ausführungsdienst finden Sie unter Zugriffskontrolle für eine API mit IAM-Berechtigungen.

Wenn sie keine InvalidateCache-Richtlinie angeben (oder das Kontrollkästchen Autorisierung erforderlich in der Konsole aktivieren), kann jeder beliebige Client den API-Zwischenspeicher entwerten. Wenn die meisten oder alle Clients den API-Cache entwerten, kann dies zu einer erheblichen Steigerung der Latenz Ihrer API führen.

Wenn die Richtlinie eingerichtet ist, wird das Caching aktiviert und eine Autorisierung ist erforderlich.

Sie können die Handhabung nicht autorisierter Anfragen steuern, indem Sie in der API-Gateway-Konsole eine der Optionen unter Unberechtigte Anfragen behandeln auswählen.

Konfigurieren einer Cache-Invalidierung

Die drei Optionen haben folgende Verhaltensweisen zur Folge:

  • Fail the request with 403 status code: gibt die Antwort „403 Unauthorized“ zurück.

    Geben Sie zum Einstellen dieser Option über die API ei FAIL_WITH_403.

  • Ignore cache control header Add a warning in response header: Bearbeiten der Anfrage und Hinzufügen eines Warn-Headers in der Antwort.

    Geben Sie zum Einstellen dieser Option über die API ei SUCCEED_WITH_RESPONSE_HEADER.

  • Ignore cache control header: Bearbeiten der Anfrage ohne Hinzufügen eines Warn-Headers in der Antwort.

    Geben Sie zum Einstellen dieser Option über die API ei SUCCEED_WITHOUT_RESPONSE_HEADER.

DatenschutzNutzungsbedingungen für die WebsiteCookie-Einstellungen
© 2025, Amazon Web Services, Inc. oder Tochtergesellschaften. Alle Rechte vorbehalten.