Kebijakan InvalidateCache

Anda sedang melihat dokumentasi Apigee Edge.
Buka Dokumentasi Apigee X. info

Mengonfigurasi cara nilai yang di-cache harus dihapus permanen dari cache.

Kebijakan ini ditujukan untuk penggunaan dalam penyimpanan cache jangka pendek dengan tujuan umum. Model ini digunakan di bersama dengan parameter Isi Kebijakan cache (untuk menulis entri) dan kebijakan Cache Pencarian (untuk membaca entri cache).

Untuk meng-cache respons resource backend, lihat metode Kebijakan Cache Respons.

Referensi elemen

Berikut daftar elemen yang dapat Anda konfigurasi pada kebijakan ini.

<InvalidateCache async="false" continueOnError="false" enabled="true" name="policy-name">
    <DisplayName>Policy Name</DisplayName>
    <CacheKey>
        <Prefix>prefix_string</Prefix>
        <KeyFragment ref="variable_reference"/>
        <KeyFragment>fragment_string</KeyFragment>
    </CacheKey>
    <!-- Omit this element if you're using the included shared cache. -->
    <CacheResource>cache_to_use</CacheResource>
    <Scope>scope_enumeration</Scope>
    <CacheContext>
        <APIProxyName>application_that_added_the_entry</APIProxyName>
        <ProxyName>proxy_for_which_data_was_cached</ProxyName>
        <TargetName>endpoint_for_which_data_was_cached</TargetName>
    </CacheContext>
    <PurgeChildEntries>true_to_purge_all_child_entries</PurgeChildEntries>
</InvalidateCache>

<InvalidateCache> atribut

Tabel berikut menjelaskan atribut yang umum untuk semua elemen induk kebijakan:

<DisplayName> elemen

Gunakan selain atribut name untuk memberi label kebijakan di editor proxy UI dengan nama natural language yang berbeda.

<DisplayName>Policy Display Name</DisplayName>

<CacheContext>/<APIProxyName> elemen

Menentukan nama aplikasi yang menambahkan entri cache.

<APIProxyName>application_that_added_the_entry</APIProxyName>

Atribut

<CacheContext> elemen

Menentukan cara membuat kunci cache jika nilai elemen Prefix tidak ditetapkan, atau untuk menghapus entri cache yang ditambahkan oleh proxy API lain.

<CacheContext>
  <APIProxyName ref="variable_name">application_that_added_the_entry</APIProxyName>
  <TargetName ref="variable_name">endpoint_for_which_data_was_cached</TargetName>
  <ProxyName ref="variable_name">proxy_for_which_data_was_cached</ProxyName>
</CacheContext>

Digunakan untuk membuat CacheKey. Nilai untuk APIProxyName, ProxyName, dan TargetName adalah wajib jika awalan CacheKey (yaitu, awalan kustom) tidak digunakan untuk menghapus entri cache ditambahkan oleh proxy API lainnya.

<CacheKey> elemen

Mengonfigurasi pointer unik ke sepotong data yang disimpan dalam cache.

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

<CacheKey> menyusun nama setiap bagian data yang disimpan dalam di cache oleh pengguna.

Saat runtime, nilai <KeyFragment> ditambahkan dengan awalan Nilai elemen <Scope> atau nilai <Prefix>. Misalnya, berikut menghasilkan kunci cache UserToken__apiAccessToken__<value_of_client_id>:

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

Anda menggunakan elemen <CacheKey> bersama dengan <Prefix> dan <Scope>. Untuk mengetahui informasi selengkapnya, lihat Bekerja dengan kunci cache.

<CacheResource> elemen

Menentukan cache tempat pesan akan disimpan.

Hilangkan sepenuhnya elemen ini jika kebijakan ini (dan Mengisi Cache dan Kebijakan LookupCache) menggunakan cache bersama yang disertakan.

<CacheResource>cache_to_use</CacheResource>

Untuk informasi selengkapnya tentang cara mengonfigurasi cache, lihat Membuat dan mengedit lingkungan cache.

<CacheKey>/<KeyFragment> elemen

Menentukan nilai yang harus disertakan dalam kunci cache, membuat namespace untuk pencocokan terhadap respons yang di-cache.

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

Ini bisa berupa kunci (nama statis yang Anda berikan) atau nilai (entri dinamis yang ditetapkan oleh merujuk ke variabel). Semua fragmen yang ditentukan digabungkan (ditambah awalan) yang digabungkan menjadi membuat kunci cache.

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

Anda menggunakan elemen <KeyFragment> bersama dengan <Prefix> dan <Scope>. Untuk mengetahui informasi selengkapnya, lihat Bekerja dengan kunci cache.

Atribut

<CacheKey>/<Prefix> elemen

Menentukan nilai yang akan digunakan sebagai awalan kunci cache.

<Prefix>prefix_string</Prefix>

Gunakan nilai ini, bukan <Scope> jika ingin menentukan nilai Anda sendiri bukan nilai yang dienumerasi <Scope>. Jika ditentukan, <Prefix> menambahkan nilai kunci cache untuk entri yang ditulis ke cache. J Nilai elemen <Prefix> mengganti elemen <Scope> dengan sejumlah nilai.

Anda menggunakan elemen <Prefix> bersama dengan <CacheKey> dan <Scope>. Untuk mengetahui informasi selengkapnya, lihat Bekerja dengan kunci cache.

<CacheContext>/<ProxyName> elemen

Menentukan nama proxy tempat data di-cache.

<ProxyName>proxy_for_which_data_was_cached</ProxyName>

Atribut

<PurgeChildEntries> elemen

true untuk menghapus permanen entri cache yang memiliki nilai yang sama yang ditetapkan oleh Elemen <KeyFragment> dikonfigurasi untuk kebijakan ini. Nilai di bagian lain dari kunci cache, seperti dalam elemen <Prefix>, tidak dipertimbangkan.

Perlu diperhatikan bahwa elemen <KeyFragment> harus ditentukan. Jika tidak, menyetel true untuk <PurgeChildEntries> dapat mengakibatkan penghapusan permanen semua entri di cache.

Membatalkan validasi semua entri cache dari nilai fragmen kunci yang sama dapat menjadi cara yang berguna untuk menghapus permanen beberapa entri yang terkait sekaligus.

<PurgeChildEntries>true_to_purge_child_entries</PurgeChildEntries>

<Scope> elemen

Enumerasi yang digunakan untuk membuat awalan untuk kunci cache saat <Prefix> tidak disediakan dalam elemen <CacheKey>.

<Scope>scope_enumeration</Scope>

Setelan <Scope> menentukan kunci cache yang ditambahkan sesuai dengan nilai <Scope>. Misalnya, kunci {i>cache<i} akan berupa bentuk berikut ketika cakupan ditetapkan ke Exclusive:

orgName__envName__applicationName__deployedRevisionNumber__proxy|TargetName__ [ serializedCacheKey ].

Jika elemen <Prefix> ada di <CacheKey>, elemen tersebut menggantikan nilai elemen <Scope>. Nilai yang valid mencakup enumerasi di bawah ini.

Anda menggunakan elemen <Scope> bersama dengan <CacheKey> dan <Prefix>. Untuk mengetahui informasi selengkapnya, lihat Bekerja dengan kunci cache.

Nilai yang dapat diterima

apifactory__test__weatherapi__16__default__apiAccessToken

&lt;CacheContext&gt;/&lt;TargetName&gt; elemen

Menentukan nama endpoint target yang datanya di-cache.

<TargetName>endpoint_for_which_data_was_cached</TargetName>

Atribut

Catatan penggunaan

Penyimpanan cache tujuan umum dengan kebijakan Isi Cache, kebijakan LookupCache, dan Kebijakan InvalidateCache menggunakan cache yang Anda konfigurasi atau cache bersama yang disertakan oleh secara default. Umumnya, cache bersama yang mendasarinya akan memenuhi kebutuhan Anda. Untuk menggunakan cache ini, cukup hapus elemen <CacheResource>.

Untuk informasi selengkapnya tentang cara mengonfigurasi cache, lihat Membuat dan mengedit lingkungan cache. Untuk mengetahui informasi selengkapnya tentang penyimpanan data pokok, lihat Cache internal.

Kode error

This section describes the error messages and flow variables that are set when this policy triggers an error. This information is important to know if you are developing fault rules for a proxy. To learn more, see What you need to know about policy errors and Handling faults.

Error code prefix

N/A

Runtime errors

This policy does not throw any runtime errors.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

N/A

Example error response

N/A