Gateway-Antworttypen für API Gateway - Amazon API Gateway

Gateway-Antworttypen für API Gateway

API Gateway stellt die folgenden Gateway-Antworten zur Anpassung durch API-Entwickler zur Verfügung.

Gateway-Antworttyp Standardstatuscode Beschreibung
ACCESS_DENIED 403

Die Gateway-Antwort bei Autorisierungsfehlern, beispielsweise bei einer Verweigerung des Zugriffs durch einen benutzerdefinierten oder Amazon Cognito-Genehmiger. Wenn kein Antworttyp angegeben ist, wird standardmäßig DEFAULT_4XX für diese Antwort verwendet.

API_CONFIGURATION_ERROR 500

Die Gateway-Antwort für eine ungültige API-Konfiguration, einschließlich wenn eine ungültige Endpunktadresse übermittelt wird, wenn die base64-Decodierung von Binärdaten bei Verwendung der binären Unterstützung fehlschlägt oder wenn das Integrationsantwort-Mapping keiner Vorlage entspricht und keine Standardvorlage konfiguriert ist. Wenn kein Antworttyp angegeben ist, wird standardmäßig DEFAULT_5XX für diese Antwort verwendet.

AUTHORIZER_CONFIGURATION_ERROR 500

Die Gateway-Antwort für eine fehlgeschlagene Verbindung zu einem benutzerdefinierten oder Amazon Cognito-Genehmiger. Wenn kein Antworttyp angegeben ist, wird standardmäßig DEFAULT_5XX für diese Antwort verwendet.

AUTHORIZER_FAILURE 500

Die Gateway-Antwort, wenn ein benutzerdefinierter oder Amazon Cognito-Genehmiger den Aufrufer nicht authentifizieren konnte. Wenn kein Antworttyp angegeben ist, wird standardmäßig DEFAULT_5XX für diese Antwort verwendet.

BAD_REQUEST_PARAMETERS 400

Die Gateway-Antwort, wenn der Anforderungsparameter nicht gemäß einem aktivierten Anforderungsvalidierer überprüft werden kann. Wenn kein Antworttyp angegeben ist, wird standardmäßig DEFAULT_4XX für diese Antwort verwendet.

BAD_REQUEST_BODY 400

Die Gateway-Antwort, wenn der Anforderungstext nicht gemäß einem aktivierten Anforderungsvalidierer überprüft werden kann. Wenn kein Antworttyp angegeben ist, wird standardmäßig DEFAULT_4XX für diese Antwort verwendet.

DEFAULT_4XX Null

Die Standard-Gateway-Antwort für einen nicht angegebenen Antworttyp mit dem Statuscode 4XX. Durch eine Änderung des Statuscodes dieser Fallback-Gateway-Antwort werden die Statuscodes von allen anderen 4XX-Antworten in den neuen Wert geändert. Mit einem Zurücksetzen des Statuscodes auf null werden die Statuscodes von sämtlichen anderen 4XX-Antworten auf ihre ursprünglichen Werte zurückgesetzt.

Anmerkung

Benutzerdefinierte AWS WAF-Antworten haben Vorrang vor benutzerdefinierten Gateway-Antworten.

DEFAULT_5XX Null

Die Standard-Gateway-Antwort für einen nicht angegebenen Antworttyp mit dem Statuscode 5XX. Durch eine Änderung des Statuscodes dieser Fallback-Gateway-Antwort werden die Statuscodes von allen anderen 5XX-Antworten in den neuen Wert geändert. Mit einem Zurücksetzen des Statuscodes auf null werden die Statuscodes von sämtlichen anderen 5XX-Antworten auf ihre ursprünglichen Werte zurückgesetzt.

EXPIRED_TOKEN 403

Die Gateway-Antwort, wenn das AWS-Authentifizierungs-Token abgelaufen ist. Wenn kein Antworttyp angegeben ist, wird standardmäßig DEFAULT_4XX für diese Antwort verwendet.

INTEGRATION_FAILURE 504

Die Gateway-Antwort bei einem Integrationsfehler. Wenn kein Antworttyp angegeben ist, wird standardmäßig DEFAULT_5XX für diese Antwort verwendet.

INTEGRATION_TIMEOUT 504

Die Gateway-Antwort, wenn das Zeitlimit für die Integration überschritten wurde. Wenn kein Antworttyp angegeben ist, wird standardmäßig DEFAULT_5XX für diese Antwort verwendet.

INVALID_API_KEY 403

Die Gateway-Antwort, wenn für eine Methode, die einen API-Schlüssel erfordert, ein ungültiger API-Schlüssel übermittelt wurde. Wenn kein Antworttyp angegeben ist, wird standardmäßig DEFAULT_4XX für diese Antwort verwendet.

INVALID_SIGNATURE 403

Die Gateway-Antwort bei einer ungültigen AWS-Signatur. Wenn kein Antworttyp angegeben ist, wird standardmäßig DEFAULT_4XX für diese Antwort verwendet.

MISSING_AUTHENTICATION_TOKEN 403

Die Gateway-Antwort, wenn das Authentifizierungs-Token fehlt. Dazu zählen auch die Fälle, bei denen der Client versucht, eine nicht unterstützte API-Methode oder -Ressource aufzurufen. Wenn kein Antworttyp angegeben ist, wird standardmäßig DEFAULT_4XX für diese Antwort verwendet.

QUOTA_EXCEEDED 429

Die Gateway-Antwort, wenn das Kontingent für den Nutzungsplan überschritten wurde. Wenn kein Antworttyp angegeben ist, wird standardmäßig DEFAULT_4XX für diese Antwort verwendet.

REQUEST_TOO_LARGE 413

Die Gateway-Antwort, wenn die Anforderung zu groß ist. Wenn kein Antworttyp angegeben ist, wird standardmäßig HTTP content length exceeded 10485760 bytes für diese Antwort verwendet.

RESOURCE_NOT_FOUND 404

Die Gateway-Antwort, wenn Amazon API Gateway die angegebene Ressource nicht finden kann, nachdem eine API-Anfrage die Authentifizierung und Autorisierung – mit Ausnahme der API-Schlüssel-Authentifizierung und -Autorisierung – durchlaufen hat. Wenn kein Antworttyp angegeben ist, wird standardmäßig DEFAULT_4XX für diese Antwort verwendet.

THROTTLED 429

Die Gateway-Antwort, wenn Drosselungslimits auf Nutzungsplan-, Methoden-, Stufen- oder Kontoebene überschritten wurden. Wenn kein Antworttyp angegeben ist, wird standardmäßig DEFAULT_4XX für diese Antwort verwendet.

UNAUTHORIZED 401

Die Gateway-Antwort, wenn der benutzerdefinierte oder Amazon Cognito-Genehmiger den Aufrufer nicht authentifizieren konnte.

UNSUPPORTED_MEDIA_TYPE 415

Die Gateway-Antwort, wenn strenges Passthrough-Verhalten aktiviert ist und eine Nutzlast einen nicht unterstützten Medientyp aufweist. Wenn kein Antworttyp angegeben ist, wird standardmäßig DEFAULT_4XX für diese Antwort verwendet.

WAF_FILTERED 403

Die Gateway-Antwort, wenn eine Anforderung von AWS WAF blockiert wird. Wenn kein Antworttyp angegeben ist, wird standardmäßig DEFAULT_4XX für diese Antwort verwendet.

Anmerkung

Benutzerdefinierte AWS WAF-Antworten haben Vorrang vor benutzerdefinierten Gateway-Antworten.