Amazon API Gateway
开发人员指南
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

网关响应类型

API Gateway 公开了以下网关响应以供 API 开发人员进行自定义。

网关响应类型 默认状态代码 描述
ACCESS_DENIED 403

授权失败的网关响应;例如,被自定义授权方或 Amazon Cognito 授权方拒绝访问时。如果未指定响应类型,则默认该响应为 DEFAULT_4XX 类型。

API_CONFIGURATION_ERROR 500

无效 API 配置的网关响应,包括提交无效的终端节点地址、在设置二进制支持时对二进制数据进行 Base64 解码失败,或者集成响应映射无法匹配任何模板且未配置默认模板。如果未指定响应类型,则默认该响应为 DEFAULT_5XX 类型。

AUTHORIZER_CONFIGURATION_ERROR 500

未能连接到自定义或 Amazon Cognito 授权方的网关响应。如果未指定响应类型,则默认该响应为 DEFAULT_5XX 类型。

AUTHORIZER_FAILURE 500

当自定义或 Amazon Cognito 授权方无法对调用方进行身份验证时的网关响应。如果未指定响应类型,则默认该响应为 DEFAULT_5XX 类型。

BAD_REQUEST_PARAMETERS 400

当无法根据已启用的请求验证程序验证请求参数时的网关响应。如果未指定响应类型,则默认该响应为 DEFAULT_4XX 类型。

BAD_REQUEST_BODY 400

当无法根据已启用的请求验证程序验证请求正文时的网关响应。如果未指定响应类型,则默认该响应为 DEFAULT_4XX 类型。

DEFAULT_4XX Null

状态代码为 4XX 的未指定响应类型的默认网关响应。更改此回退网关响应的状态代码会将所有其他 4XX 响应的状态代码更改为新值。将此状态代码重置为 Null 会使所有其他 4XX 响应的状态代码恢复到原始值。

DEFAULT_5XX Null

状态代码为 5XX 的未指定响应类型的默认网关响应。更改此回退网关响应的状态代码会将所有其他 5XX 响应的状态代码更改为新值。将此状态代码重置为 Null 会使所有其他 5XX 响应的状态代码恢复到原始值。

EXPIRED_TOKEN 403

发生 AWS 身份验证令牌过期错误时的网关响应。如果未指定响应类型,则默认该响应为 DEFAULT_4XX 类型。

INTEGRATION_FAILURE 504

发生集成失败错误时的网关响应。如果未指定响应类型,则默认该响应为 DEFAULT_5XX 类型。

INTEGRATION_TIMEOUT 504

发生集成超时错误时的网关响应。如果未指定响应类型,则默认该响应为 DEFAULT_5XX 类型。

INVALID_API_KEY 403

为要求 API 密钥的方法提交无效 API 密钥时的网关响应。如果未指定响应类型,则默认该响应为 DEFAULT_4XX 类型。

INVALID_SIGNATURE 403

发生无效的 AWS 签名错误时的网关响应。如果未指定响应类型,则默认该响应为 DEFAULT_4XX 类型。

MISSING_AUTHENTICATION_TOKEN 403

发生缺少身份验证令牌错误时的网关响应,包括客户端尝试调用不受支持的 API 方法或资源的情况。如果未指定响应类型,则默认该响应为 DEFAULT_4XX 类型。

QUOTA_EXCEEDED 429

发生超出使用计划配额错误时的网关响应。如果未指定响应类型,则默认该响应为 DEFAULT_4XX 类型。

REQUEST_TOO_LARGE 413

发生请求太大错误时的网关响应。如果未指定响应类型,则默认该响应为 DEFAULT_4XX 类型。

RESOURCE_NOT_FOUND 404

在 API 请求通过身份验证和授权 (不包括 API 密钥身份验证和授权) 后,API Gateway 找不到指定资源时的网关响应。如果未指定响应类型,则默认该响应为 DEFAULT_4XX 类型。

THROTTLED 429

当超出使用计划、方法、阶段或账户的节流限制时的网关响应。如果未指定响应类型,则默认该响应为 DEFAULT_4XX 类型。

UNAUTHORIZED 401

当自定义或 Amazon Cognito 授权方无法对调用方进行身份验证时的网关响应。

UNSUPPORTED_MEDIA_TYPE 415

当启用严格的传递限制后,负载为不受支持的媒体类型时的网关类型。如果未指定响应类型,则该响应默认为 DEFAULT_4XX 类型。

WAF_FILTERED 403

当请求被 AWS WAF 阻止时的网关响应。如果未指定响应类型,则该响应默认为 DEFAULT_4XX 类型。