

# API Gateway 的网关响应类型
<a name="supported-gateway-response-types"></a>

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


| 网关响应类型 | 默认状态代码 | 说明 | 
| --- | --- | --- | 
| ACCESS\$1DENIED | 403 | 授权失败的网关响应；例如，被自定义授权方或 Amazon Cognito 授权方拒绝访问时。如果未指定响应类型，则默认该响应为 `DEFAULT_4XX` 类型。 | 
| API\$1CONFIGURATION\$1ERROR | 500 | 无效 API 配置的网关响应，包括提交无效的端点地址时，在设置二进制支持时对二进制数据进行 Base64 解码失败时，或者集成响应映射无法匹配任何模板且未配置默认模板时。如果未指定响应类型，则默认该响应为 `DEFAULT_5XX` 类型。 | 
| AUTHORIZER\$1CONFIGURATION\$1ERROR | 500 | 未能连接到自定义或 Amazon Cognito 授权方的网关响应。如果未指定响应类型，则默认该响应为 `DEFAULT_5XX` 类型。 | 
| AUTHORIZER\$1FAILURE | 500 | 当自定义或 Amazon Cognito 授权方无法对调用方进行身份验证时的网关响应。如果未指定响应类型，则默认该响应为 `DEFAULT_5XX` 类型。 | 
| BAD\$1REQUEST\$1PARAMETERS | 400 | 当无法根据已启用的请求验证程序验证请求参数时的网关响应。如果未指定响应类型，则默认该响应为 `DEFAULT_4XX` 类型。 | 
| BAD\$1REQUEST\$1BODY | 400 | 当无法根据已启用的请求验证程序验证请求正文时的网关响应。如果未指定响应类型，则默认该响应为 `DEFAULT_4XX` 类型。 | 
| DEFAULT\$14XX |  Null | 状态代码为 `4XX` 的未指定响应类型的默认网关响应。更改此回退网关响应的状态代码会将所有其他 `4XX` 响应的状态代码更改为新值。将此状态代码重置为 Null 会使所有其他 `4XX` 响应的状态代码恢复到原始值。  [Amazon WAF 自定义响应](https://docs.amazonaws.cn/waf/latest/developerguide/waf-custom-request-response.html)优先于自定义网关响应。   | 
| DEFAULT\$15XX | Null | 状态代码为 `5XX` 的未指定响应类型的默认网关响应。更改此回退网关响应的状态代码会将所有其他 `5XX` 响应的状态代码更改为新值。将此状态代码重置为 Null 会使所有其他 `5XX` 响应的状态代码恢复到原始值。 | 
| EXPIRED\$1TOKEN | 403 | 发生 Amazon 身份验证令牌过期错误时的网关响应。如果未指定响应类型，则默认该响应为 `DEFAULT_4XX` 类型。 | 
| INTEGRATION\$1FAILURE | 504 | 发生集成失败错误时的网关响应。如果未指定响应类型，则默认该响应为 `DEFAULT_5XX` 类型。 | 
| INTEGRATION\$1TIMEOUT | 504 | 发生集成超时错误时的网关响应。如果未指定响应类型，则默认该响应为 `DEFAULT_5XX` 类型。 | 
| INVALID\$1API\$1KEY | 403 | 为要求 API 密钥的方法提交无效 API 密钥时的网关响应。如果未指定响应类型，则默认该响应为 `DEFAULT_4XX` 类型。 | 
| INVALID\$1SIGNATURE | 403 | 发生无效的 Amazon 签名错误时的网关响应。如果未指定响应类型，则默认该响应为 `DEFAULT_4XX` 类型。 | 
| MISSING\$1AUTHENTICATION\$1TOKEN | 403 | 发生缺少身份验证令牌错误时的网关响应，包括客户端尝试调用不受支持的 API 方法或资源的情况。如果未指定响应类型，则默认该响应为 `DEFAULT_4XX` 类型。 | 
| QUOTA\$1EXCEEDED | 429 | 发生超出使用计划配额错误时的网关响应。如果未指定响应类型，则默认该响应为 `DEFAULT_4XX` 类型。 | 
| REQUEST\$1TOO\$1LARGE | 413 | 发生请求太大错误时的网关响应。如果未指定响应类型，则该响应默认为：`HTTP content length exceeded 10485760 bytes`。 | 
| RESOURCE\$1NOT\$1FOUND | 404 | 在 API 请求通过身份验证和授权（不包括 API 密钥身份验证和授权）后，API Gateway 找不到指定资源时的网关响应。如果未指定响应类型，则默认该响应为 `DEFAULT_4XX` 类型。 | 
| THROTTLED | 429 | 当超出使用计划、方法、阶段或账户的节流限制时的网关响应。如果未指定响应类型，则默认该响应为 `DEFAULT_4XX` 类型。 | 
| UNAUTHORIZED | 401 | 当自定义或 Amazon Cognito 授权方无法对调用方进行身份验证时的网关响应。 | 
| UNSUPPORTED\$1MEDIA\$1TYPE | 415 | 当启用严格的传递限制后，负载为不受支持的媒体类型时的网关类型。如果未指定响应类型，则默认该响应为 `DEFAULT_4XX` 类型。 | 
| WAF\$1FILTERED | 403 | 当请求被 阻止时的网关响应Amazon WAF 如果未指定响应类型，则默认该响应为 `DEFAULT_4XX` 类型。  [Amazon WAF 自定义响应](https://docs.amazonaws.cn/waf/latest/developerguide/waf-custom-request-response.html)优先于自定义网关响应。   | 