LookupCache 政策

查看 Apigee Edge 說明文件。
前往 Apigee X說明文件。 資訊

設定在執行階段擷取快取值的方式。

這項政策適用於一般用途的短期快取，用於 搭配 Populate 快取政策 (用於寫入項目) 和撤銷快取政策 (用於撤銷項目)。

如要快取後端資源的回應，請參閱 回應快取政策：

元素參照

以下列出您可以為這項政策設定的元素。

<LookupCache async="false" continueOnError="false" enabled="true" name="Lookup-Cache-1">
    <DisplayName>Lookup Cache 1</DisplayName>
    <Properties/>
    <CacheKey>
        <Prefix/>
        <KeyFragment ref=""/>
    </CacheKey>
    <!-- Omit this element if you're using the included shared cache. -->
    <CacheResource/>
    <CacheLookupTimeoutInSeconds/>
    <Scope>Exclusive</Scope>
    <AssignTo>flowVar</AssignTo>
</LookupCache>

根據預設，系統會納入共用快取。如要使用共用快取，請省略 這項政策設定中的 <CacheResource> 個元素。

如要進一步瞭解基礎資料儲存庫，請參閱「快取內部」。進一步瞭解如何設定 快取，請參閱建立及編輯 環境快取。

<LookupCache>屬性

下表說明所有政策父項元素的共同屬性：

<DisplayName>元素

除 name 屬性外，一併使用 管理 UI Proxy 編輯器，使用不同的自然語言名稱。

<DisplayName>Policy Display Name</DisplayName>

<AssignTo>元素

指定從 快取。這個變數必須可寫入。如果快取查詢沒有擷取值，變數會 不會設定。

<AssignTo>variable_to_receive_cached_value</AssignTo>

<CacheKey>元素

設定儲存在快取中資料的唯一指標。

<CacheKey>
    <Prefix>string</Prefix>
    <KeyFragment ref="variable_name" />
    <KeyFragment>literal_string</KeyFragment>
</CacheKey>

<CacheKey> 會建立儲存在 快取。

在執行階段，<KeyFragment> 值會在前面加上 <Scope> 元素值或 <Prefix> 值。舉例來說， 產生的快取金鑰 UserToken__apiAccessToken__<value_of_client_id>:

<CacheKey>
    <Prefix>UserToken</Prefix>
    <KeyFragment>apiAccessToken</KeyFragment>
    <KeyFragment ref="request.queryparam.client_id" />
</CacheKey>

請將 <CacheKey> 元素與 <Prefix>和<Scope>。詳情請參閱使用快取金鑰。

<CacheLookupTimeoutInSeconds>元素

指定快取查詢失敗的秒數後，系統會視為 快取失敗。如果發生這種情況，流程會沿著快取遺漏的路徑繼續執行。

<CacheLookupTimeoutInSeconds>30</CacheLookupTimeoutInSeconds>

<CacheResource>元素

指定應儲存訊息的快取。

如果這項政策 (以及對應的 PopulateCache 與 InvalidateCache 政策) 使用的是隨附共用快取。

<CacheResource>cache_to_use</CacheResource>

如要進一步瞭解如何設定快取，請參閱建立及編輯環境 快取。

<CacheKey>/<KeyFragment>元素

指定要納入快取金鑰的值，建立用來比對的命名空間 快取回應產生的要求。

<KeyFragment ref="variable_name"/>
<KeyFragment>literal_string</KeyFragment>

這可以是鍵 (您提供的靜態名稱) 或值 (由 參照變數)。所有指定片段組合 (加上前置字串) 都會串連 建立快取金鑰

<KeyFragment>apiAccessToken</KeyFragment>
<KeyFragment ref="request.queryparam.client_id" />

請將 <KeyFragment> 元素與 <Prefix>和<Scope>。詳情請參閱使用快取金鑰。

屬性

<CacheKey>/<Prefix>元素

指定要做為快取金鑰前置字串的值。

<Prefix>prefix_string</Prefix>

如要指定自己的值，請使用這個值，而非 <Scope> 而非 <Scope> 列舉值。如已定義 <Prefix> 會在寫入快取的項目前面加上快取金鑰值。A 罩杯 <Prefix> 元素值會覆寫 <Scope> 元素 值。

請將 <Prefix> 元素與 <CacheKey>和<Scope>。詳情請參閱使用快取金鑰。

<Scope>元素

在 <Prefix> 時，用於建構快取金鑰的前置字串的列舉 未在 <CacheKey> 元素中提供。

<Scope>scope_enumeration</Scope>

<Scope> 設定會決定系統會根據 <Scope> 值。舉例來說，快取金鑰採用以下格式時 範圍設為「Exclusive」： orgName__envName__applicationName__deployedRevisionNumber__proxy|TargetName__ [ serializedCacheKey]。

如果 <CacheKey> 中有 <Prefix> 元素， 會取代 <Scope> 元素值。有效值包括列舉值 。

請將 <Scope> 元素與 <CacheKey>和<Prefix>。詳情請參閱使用快取金鑰。

可接受的值

apifactory__test__weatherapi__16__default__apiAccessToken

使用須知

請將這項政策用於一般用途的快取。在執行階段，LookupCache 政策會擷取 值，將該值指派給您使用 AssignTo 元素指定的變數 (如果沒有擷取任何值，就不會設定該變數)。根據快取尋找值 索引鍵是透過結合 CacheKey 和 Scope 元素的設定建立。也就是 擷取 PopulateCache 政策新增至快取的特定值，您的 LookupCache 政策必須以與 PopulateCache 相同的方式設定快取金鑰相關元素 政策。

使用填入快取政策進行一般用途快取， LookupCache 政策和 InvalidateCache 政策 您設定的快取或預設包含的共用快取。在大多數的情況下， 基本共用快取就能滿足需求如要使用預設快取，只要省略 <CacheResource> 元素。

如要進一步瞭解如何設定快取，請參閱建立及編輯環境 快取。如要進一步瞭解基礎資料儲存庫，請參閱「快取內部」。

流程變數

流程變數可用來設定政策和流程的動態執行階段行為，以 ，或資料流中可用的內容。如要進一步瞭解 請參閱變數 參考資料。

自訂 您在 LookupCache 政策中定義的快取資料。

錯誤代碼

本節說明這項政策觸發錯誤時設定的錯誤訊息和流程變數。如果您正在開發 Proxy 的錯誤規則，請務必瞭解這項資訊。詳情請參閱「政策錯誤須知」和「處理錯誤」。

錯誤代碼前置字串

不適用

執行階段錯誤

這項政策不會擲回任何執行階段錯誤。

部署錯誤

若您部署包含這項政策的 Proxy，就可能會發生這些錯誤。

錯誤變數

不適用

錯誤回應範例

不適用