Tipos de respostas do gateway - Amazon API Gateway

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Tipos de respostas do gateway

O API Gateway expõe as seguintes respostas de gateway para personalização pelos desenvolvedores de APIs.

Tipo de resposta do Gateway Código de status de padrão Descrição
ACCESS_DENIED 403

A resposta de gateway para uma falha de autorização; por exemplo, quando o acesso é negado por um autorizador personalizado ou do Amazon Cognito. Se o tipo de resposta não for especificado, essa resposta assumirá como padrão o tipo DEFAULT_4XX.

API_CONFIGURATION_ERROR 500

A resposta do gateway para uma configuração de API inválida, incluindo quando um endereço de endpoint inválido é enviado, quando a decodificação em base64 falha nos dados binários quando o suporte binário está implementado ou quando o mapeamento da resposta de integração não pode corresponder a nenhum modelo e nenhum modelo padrão está configurado. Se o tipo de resposta não for especificado, essa resposta assumirá como padrão o tipo DEFAULT_5XX.

AUTHORIZER_CONFIGURATION_ERROR 500

A resposta de gateway por não conseguir se conectar a um autorizador personalizado ou do Amazon Cognito. Se o tipo de resposta não for especificado, essa resposta assumirá como padrão o tipo DEFAULT_5XX.

AUTHORIZER_FAILURE 500

A resposta de gateway quando um autorizador personalizado ou do Amazon Cognito falhou ao autenticar o autor da chamada. Se o tipo de resposta não for especificado, essa resposta assumirá como padrão o tipo DEFAULT_5XX.

BAD_REQUEST_PARAMETERS 400

A resposta de gateway quando o parâmetro de solicitação não pode ser validado de acordo com um validador de solicitação ativado. Se o tipo de resposta não for especificado, essa resposta assumirá como padrão o tipo DEFAULT_4XX.

BAD_REQUEST_BODY 400

A resposta de gateway quando o corpo da solicitação não pode ser validado de acordo com um validador de solicitação ativado. Se o tipo de resposta não for especificado, essa resposta assumirá como padrão o tipo DEFAULT_4XX.

DEFAULT_4XX Nulo

A resposta de gateway padrão para um tipo de resposta não especificado com o código de status de 4XX. Alterar o código de status dessa resposta de gateway de retorno altera os códigos de status de todas as outras respostas 4XX para o novo valor. Redefinir esse código de status para nulo reverte os códigos de status de todas as outras respostas 4XX para seus valores originais.

nota

As respostas personalizadas do AWS WAF têm precedência sobre as respostas personalizadas do gateway.

DEFAULT_5XX Nulo

A resposta de gateway padrão para um tipo de resposta não especificado com um código de status de 5XX. Alterar o código de status dessa resposta de gateway de retorno altera os códigos de status de todas as outras respostas 5XX para o novo valor. Redefinir esse código de status para nulo reverte os códigos de status de todas as outras respostas 5XX para seus valores originais.

EXPIRED_TOKEN 403

A resposta de gateway para um erro de token de autenticação do AWS expirado. Se o tipo de resposta não for especificado, essa resposta assumirá como padrão o tipo DEFAULT_4XX.

INTEGRATION_FAILURE 504

A resposta de gateway para um erro de integração com falha. Se o tipo de resposta não for especificado, essa resposta assumirá como padrão o tipo DEFAULT_5XX.

INTEGRATION_TIMEOUT 504

A resposta de gateway para um erro de tempo limite de integração. Se o tipo de resposta não for especificado, essa resposta assumirá como padrão o tipo DEFAULT_5XX.

INVALID_API_KEY 403

A resposta do gateway para uma chave de API inválida enviada para um método que requer uma chave de API. Se o tipo de resposta não for especificado, essa resposta assumirá como padrão o tipo DEFAULT_4XX.

INVALID_SIGNATURE 403

A resposta do gateway para um erro de assinatura da AWS inválido. Se o tipo de resposta não for especificado, essa resposta assumirá como padrão o tipo DEFAULT_4XX.

MISSING_AUTHENTICATION_TOKEN 403

A resposta de gateway para um erro de token de autenticação ausente, incluindo casos quando o cliente tenta invocar um método de API ou recurso sem suporte. Se o tipo de resposta não for especificado, essa resposta assumirá como padrão o tipo DEFAULT_4XX.

QUOTA_EXCEEDED 429

A resposta de gateway para o erro de cota de plano de uso excedida. Se o tipo de resposta não for especificado, essa resposta assumirá como padrão o tipo DEFAULT_4XX.

REQUEST_TOO_LARGE 413

A resposta de gateway para o erro de solicitação muito grande. Se o tipo de resposta não for especificado, essa resposta assumirá como padrão o tipo DEFAULT_4XX.

RESOURCE_NOT_FOUND 404

A resposta de gateway quando o API Gateway não consegue localizar o recurso especificado depois que uma solicitação de API passa na autenticação e na autorização, exceto para a autorização e a autenticação da chave de API. Se o tipo de resposta não for especificado, essa resposta assumirá como padrão o tipo DEFAULT_4XX.

THROTTLED 429

A resposta de gateway quando limites de controle de fluxo em nível de plano de uso, método, estágio ou conta são excedidos. Se o tipo de resposta não for especificado, essa resposta assumirá como padrão o tipo DEFAULT_4XX.

UNAUTHORIZED 401

A resposta de gateway quando o autorizador personalizado ou do Amazon Cognito falhou ao autenticar o autor da chamada.

UNSUPPORTED_MEDIA_TYPE 415

A resposta de gateway quando a carga é de um tipo de mídia sem suporte, se o comportamento de passagem direta estrita estiver habilitado. Se o tipo de resposta não for especificado, essa resposta assumirá como padrão o tipo DEFAULT_4XX.

WAF_FILTERED 403

A resposta de gateway quando uma solicitação é bloqueada pelo AWS WAF. Se o tipo de resposta não for especificado, essa resposta assumirá como padrão o tipo DEFAULT_4XX.

nota

As respostas personalizadas do AWS WAF têm precedência sobre as respostas personalizadas do gateway.