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

API Gateway RESTAPIs中的 的快取設定

您可以在 API Gateway API 中啟用快取，以快取端點的回應。透過快取，您可以減少對端點進行的呼叫數量，也可以改善對 的請求延遲API。

當您為階段啟用快取時，APIGateway 會在指定的 time-to-live （TTL） 期間內快取來自端點的回應，以秒為單位。API Gateway 會透過從快取中查詢端點回應來回應請求，而不是向端點提出請求。API 快取的TTL預設值為 300 秒。TTL 最大值為 3600 秒。TTL=0 表示快取已停用。

可以快取的回應大小上限是 1048576 個位元組。快取資料加密可能會在快取回應時增加回應的大小。

這是HIPAA符合資格的服務。如需有關 AWS、1996 年美國健康保險可攜性和責任法案 （HIPAA） 以及使用 AWS 服務來處理、存放和傳輸受保護健康資訊 （PHI） 的詳細資訊，請參閱HIPAA概觀 。

啟用 Amazon API Gateway 快取

在API閘道中，您可以針對特定階段啟用快取。

當您啟用快取，您必須選擇快取容量。一般而言，容量越大效能越佳，但成本也越高。如需支援的快取大小，請參閱閘道參考 cacheClusterSize 中的 。 API API

API Gateway 透過建立專用快取執行個體來啟用快取。此程序最多需要 4 分鐘的時間。

API Gateway 透過移除現有的快取執行個體並建立具有修改後容量的新快取執行個體來變更快取容量。所有現有的快取資料都會遭到刪除。

在API閘道主控台中，您可以在階段頁面上設定快取。您可以佈建階段快取，並指定預設方法層級快取設定。如果您開啟預設方法層級快取，則除非該方法具有方法覆寫，否則階段上所有GET方法的方法層級快取都會開啟。您部署到階段的任何其他GET方法都會有方法層級快取。若要為階段的特定方法設定方法層級快取設定，您可以使用方法覆寫。如需方法覆寫的詳細資訊，請參閱 覆寫方法層級快取的API閘道階段層級快取。

當您在階段的快取設定中啟用快取時，只會啟用 GET 方法的快取。為了確保 的安全性和可用性API，建議您不要變更此設定。但是，您可以透過覆寫方法設定，來啟用其他方法的快取。

如果您想要確認快取是否如預期般運作，您有兩個一般選項：

覆寫方法層級快取的API閘道階段層級快取

您可以開啟或關閉特定方法的快取，以覆寫階段層級快取設定。您也可以修改TTL期間，或開啟或關閉快取回應的加密。

如果您在階段詳細資訊 中變更預設方法層級快取設定，不會影響具有覆寫的方法層級快取設定。

如果您預期正在快取的方法會在其回應中收到敏感性資料，請在 Cache Settings (快取設定) 中，選擇 Encrypt cache data (加密快取資料)。

使用方法或整合參數作為快取金鑰來編製快取回應的索引

您可以使用 方法或整合參數作為快取金鑰，來索引快取的回應。這包括自訂標頭、URL路徑或查詢字串。您可以指定部分或全部這些參數作為快取金鑰，但必須至少指定一個值。當您有快取金鑰時，APIGateway 會分別快取每個金鑰值的回應，包括快取金鑰不存在時。

例如，假設您有一個請求，其格式如下：

GET /users?type=... HTTP/1.1
host: example.com
...
        

在此請求中，type 可接受 admin 或 regular 值。如果您包含 type 參數作為快取金鑰的一部分，則會分別快取 GET /users?type=admin 的回應與 GET /users?type=regular 的回應。

當方法或整合請求接受多個參數時，您可以選擇包含部分或所有參數來建立快取金鑰。例如，您只能將type參數包含在下列請求的快取金鑰中，並在TTL一段時間內以列出的順序提出：

GET /users?type=admin&department=A HTTP/1.1
host: example.com
...
        

從這個請求的響應被緩存，並用於服務於以下請求：

GET /users?type=admin&department=B HTTP/1.1
host: example.com
...
        

若要在API閘道主控台中將方法或整合請求參數包含在快取金鑰中，請在新增參數後選取快取。

排清 API Gateway 中的API階段快取

啟用API快取時，您可以排清API階段的快取，以確保 API的用戶端從整合端點取得最新的回應。

若要排清API階段快取，請選擇階段動作選單，然後選擇排清階段快取。

使API閘道快取項目無效

您 的用戶端API可以將現有的快取項目失效，並從個別請求的整合端點重新載入。用戶端必須傳送含有 Cache-Control: max-age=0 標頭的請求。只要授權用戶端執行這項作業，用戶端就可以直接從整合端點 (而不是快取) 接收回應。這會以擷取自整合端點的新回應來取代現有的快取項目。

若要授予用戶端許可，請將下列格式的政策連接至使用者的IAM執行角色。

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "execute-api:InvalidateCache"
      ],
      "Resource": [
        "arn:aws:execute-api:region:account-id:api-id/stage-name/GET/resource-path-specifier"
      ]
    }
  ]
}            
        

此政策允許API閘道執行服務將指定資源 （或 資源） 上請求的快取失效。若要指定目標資源群組，請針對 account-id、 api-id和 ARN 值中的其他項目使用萬用字元 （*） 字元Resource。如需如何設定API閘道執行服務許可的詳細資訊，請參閱 控制對RESTAPI具有IAM權限的訪問。

如果您沒有強加InvalidateCache政策 （或在主控台中選擇需要授權核取方塊），任何用戶端都可以使API快取失效。如果大多數或所有用戶端使API快取失效，可能會大幅增加 的延遲API。

當政策設定完成時，便會啟用快取，且需要授權。

您可以在API閘道主控台中選擇未授權請求處理的選項，以控制未經授權請求的處理方式。

這三個選項會導致下列行為：