

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# API Gateway 的閘道回應類型
<a name="supported-gateway-response-types"></a>

 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` 回應的狀態碼還原成其原始值。 [AWS WAF 自訂回應](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)優先於自訂閘道回應。  | 
| 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 | 請求太大錯誤的閘道回應。如果未指定回應類型，此回應預設為：`HTTP content length exceeded 10485760 bytes`。 | 
| 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` 類型。 [AWS WAF 自訂回應](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)優先於自訂閘道回應。  | 