適用於:所有 APIM 層
cache-store-value 會依索引鍵執行快取儲存。 金鑰可以具有任意字串值,而且通常會使用原則運算式來提供。
注意
此原則所執行的值,儲存於快取中的作業為非同步。 您可以使用從快取原則取得值來擷取預存值。 不過,該預存值可能不會立即可供擷取,因為將值預存於快取中的非同步作業,可能還在進行中。
重要
內建快取具揮發性,且相同區域的所有單位共用相同的 API 管理服務。
注意
請依照原則陳述式中提供的順序,來設定原則的元素和子元素。 深入了解如何設定或編輯 APIM 原則。
原則陳述式
<cache-store-value key="cache key value" value="value to cache" duration="seconds" caching-type="prefer-external | external | internal" />
屬性
| 屬性 | 描述 | 是必要欄位 | 預設 |
|---|---|---|---|
| caching-type | 選擇下列屬性值: - internal,使用內建的 APIM 快取,- external,使用外部快取,如在 Azure API 管理中使用外部 Azure Redis 快取中所述,- prefer-external。如有設定,則使用外部快取;否則使用內部快取。不允許使用原則運算式。 |
否 | prefer-external |
| 持續時間 | 會針對所提供的持續時間值來快取值,以秒為單位進行指定。 允許使用原則運算式。 | 是的 | N/A |
| Key | 用來做為值儲存依據的快取索引鍵。 允許使用原則運算式。 | 是的 | N/A |
| 價值 | 要快取的值。 允許使用原則運算式。 | 是的 | N/A |
使用方式
使用量注意事項
- API 管理 只會快取 HTTP GET 要求的回應。
- 此原則只能在原則區段中使用一次。
- 建議您在任何快取查閱之後立即設定 速率限制 原則 (或依 金鑰的速率限制 原則)。 這有助於防止您的後端服務在快取無法使用時過載。
範例
此範例示範如何使用原則將 cache-store-value 使用者設定檔儲存在快取中。 快取項目的索引鍵是使用原則表示式來建構,該原則表示式會結合字串與環境定義變數的 enduserid 值。
請參閱 cache-lookup-value 範例,以從快取擷取使用者設定檔。
<cache-store-value
key="@("userprofile-" + context.Variables["enduserid"])"
value="@((string)context.Variables["userprofile"])" duration="100000" />
如需此原則的詳細資訊和範例,請參閱在 Azure API 管理中自訂快取。
相關原則
相關內容
如需使用原則的詳細資訊,請參閱:
- 教學課程:轉換及保護 API
- 原則參考,取得原則陳述式及其設定的完整清單
- 原則運算式
- 設定或編輯原則
- 重複使用原則設定
- 原則程式碼片段存放庫 (英文)
- 原則遊樂場存放庫
- Azure API 管理 原則工具組
- 取得 Copilot 協助以建立、說明及疑難排解原則