Kebijakan InvalidateCache

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Baca dokumentasi Apigee Edge.

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

Kebijakan ini dimaksudkan untuk digunakan dalam cache jangka pendek tujuan umum. API ini digunakan bersama dengan kebijakan FillCache (untuk menulis entri) dan kebijakan LookupCache (untuk membaca entri cache).

Untuk menyimpan respons resource backend dalam cache, lihat kebijakan ResponseCache.

Kebijakan ini merupakan Kebijakan yang dapat diperluas, dan penggunaan kebijakan ini mungkin memiliki implikasi biaya atau pemanfaatan, bergantung pada lisensi Apigee Anda. Untuk mengetahui informasi tentang jenis kebijakan dan implikasi penggunaan, lihat Jenis kebijakan.

Catatan: Untuk menghapus cache di luar alur pesan tanpa kebijakan, Anda dapat menggunakan Delete caches API.

Referensi elemen

Berikut ini daftar elemen yang dapat Anda konfigurasi di 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>

Atribut <InvalidateCache>

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

Atribut	Deskripsi	Default	Kehadiran
name	Nama internal kebijakan. Nilai atribut name dapat berisi huruf, angka, spasi, tanda hubung, garis bawah, dan titik. Nilai ini tidak boleh melebihi 255 karakter. Atau, gunakan elemen <DisplayName> untuk memberi label kebijakan di editor proxy UI pengelolaan dengan nama natural-language yang berbeda.	T/A	Diperlukan
continueOnError	Setel ke false untuk menampilkan error jika kebijakan gagal. Ini adalah perilaku yang wajar untuk sebagian besar kebijakan. Setel ke true agar eksekusi alur tetap berlanjut bahkan setelah kebijakan gagal. Lihat juga: Aturan error HANYA dipicu dalam status error (tentang continueOnError) Menangani kesalahan dalam alur saat ini	false	Opsional
enabled	Setel ke true untuk menerapkan kebijakan. Setel ke false untuk menonaktifkan kebijakan. Kebijakan tidak akan diterapkan meskipun tetap melekat pada alur.	true	Opsional
async	Atribut ini sudah tidak digunakan lagi.	false	Tidak digunakan lagi

Elemen <DisplayName>

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

<DisplayName>Policy Display Name</DisplayName>

Default	T/A Jika Anda menghapus elemen ini, nilai atribut name kebijakan akan digunakan.
Kehadiran	Opsional
Jenis	String

Elemen <CacheContext>/<APIProxyName>

Menentukan nama aplikasi yang menambahkan entri cache.

<APIProxyName>application_that_added_the_entry</APIProxyName>

Atribut

Atribut	Deskripsi	Default	Kehadiran	Jenis
referensi	Variabel dengan nama aplikasi.	T/A	Opsional	String

Elemen <CacheContext>

Menentukan cara membuat kunci cache ketika nilai elemen Prefix tidak ditentukan, atau 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 bersifat wajib jika awalan CacheKey (yaitu, awalan kustom) tidak digunakan untuk menghapus entri cache yang ditambahkan oleh proxy API lain.

Elemen <CacheKey>

Mengonfigurasi pointer unik ke bagian data yang disimpan dalam cache.

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

Default:	T/A
Kehadiran:	Diperlukan
Jenis:	T/A

<CacheKey> membuat nama setiap bagian data yang disimpan dalam cache.

Saat runtime, nilai <KeyFragment> diawali dengan nilai elemen <Scope> atau nilai <Prefix>. Misalnya, kode 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.

Elemen <CacheResource>

Menentukan cache tempat pesan harus disimpan.

Hapus elemen ini sepenuhnya jika kebijakan ini (dan kebijakan filledCache dan LookupCache yang sesuai) menggunakan cache bersama yang disertakan.

<CacheResource>cache_to_use</CacheResource>

Default:	T/A
Kehadiran:	Opsional
Jenis:	String

Untuk informasi selengkapnya tentang mengonfigurasi cache, lihat Cache tujuan umum.

Elemen <CacheKey>/<KeyFragment>

Menentukan nilai yang harus disertakan dalam kunci cache. Tentukan variabel yang akan dihilangkan referensinya dengan atribut ref, atau nilai tetap.

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

Default:	T/A
Kehadiran:	Opsional
Jenis:	T/A

Saat runtime, Apigee membuat kunci cache dengan mengawali nilai yang diperoleh dari elemen <Scope> atau <Prefix>, ke penyambungan nilai yang di-resolve dari setiap elemen <KeyFragment>. Untuk mengetahui informasi selengkapnya, lihat Bekerja dengan kunci cache.

Atribut

Atribut	Deskripsi	Default	Kehadiran	Jenis
referensi	Variabel yang digunakan untuk mendapatkan nilai. Tidak boleh digunakan jika elemen ini berisi nilai literal.	T/A	Opsional	String

Elemen <CacheKey>/<Prefix>

Menentukan nilai yang akan digunakan sebagai awalan kunci cache.

<Prefix>prefix_string</Prefix>

Default:	T/A
Kehadiran:	Opsional
Jenis:	String

Elemen <Prefix> mengganti elemen <Scope>.

Saat runtime, Apigee membuat kunci cache dengan mengawali nilai yang diperoleh dari elemen <Scope> atau <Prefix>, ke penyambungan nilai yang di-resolve dari setiap elemen <KeyFragment>. Untuk mengetahui informasi selengkapnya, lihat Bekerja dengan kunci cache.

Elemen <CacheContext>/<ProxyName>

Menentukan nama proxy yang datanya di-cache.

<ProxyName>proxy_for_which_data_was_cached</ProxyName>

Default:	T/A
Kehadiran:	Opsional
Jenis:	String

Atribut

Atribut	Deskripsi	Default	Kehadiran	Jenis
referensi	Variabel yang digunakan untuk mendapatkan nilai. Tidak boleh digunakan jika elemen ini berisi nilai literal.	T/A	Opsional	String

Elemen <PurgeChildEntries>

true untuk menghapus permanen entri cache dengan nilai <Prefix> yang sama seperti yang dikonfigurasi untuk kebijakan ini, meskipun instance kebijakan FillCache yang memuat item tersebut ke cache juga menggunakan berbagai elemen <KeyFragment>.

Dengan membatalkan validasi semua entri cache dari nilai awalan yang sama, Anda dapat menghapus permanen beberapa entri terkait sekaligus.

<PurgeChildEntries>true_to_purge_child_entries</PurgeChildEntries>

Default:	false
Kehadiran:	Opsional
Jenis:	Boolean

Elemen <Scope>

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

<Scope>scope_enumeration</Scope>

Default:	"Eksklusif"
Kehadiran:	Opsional
Jenis:	String

Setelan <Scope> menentukan kunci cache yang ditambahkan sesuai dengan nilai <Scope>. Misalnya, kunci cache akan berbentuk seperti berikut jika cakupan ditetapkan ke Exclusive:

orgName__envName__applicationName__deployedRevisionNumber__proxy|TargetName__ [ serializedCacheKey ].

Jika elemen <Prefix> ada di <CacheKey>, elemen tersebut akan menggantikan nilai elemen <Scope>. Nilai yang valid untuk elemen <Scope> ditampilkan di bawah ini.

Untuk mengetahui informasi selengkapnya, lihat Bekerja dengan kunci cache.

Nilai yang dapat diterima

Nilai Cakupan	Deskripsi
Global	Kunci cache dibagikan ke semua proxy API yang di-deploy di lingkungan. Kunci cache ditambahkan dalam bentuk orgName __ envName __. Jika Anda menentukan entri <CacheKey> dengan apiAccessToken <KeyFragment> dan cakupan <Global>, setiap entri akan disimpan sebagai orgName__envName__apiAccessToken, diikuti dengan nilai token akses yang diserialisasi. Untuk proxy API yang di-deploy di lingkungan yang disebut 'test' dalam organisasi yang disebut 'apifactory', token akses akan disimpan dengan kunci cache berikut: apifactory__test__apiAccessToken.
Application	Nama proxy API digunakan sebagai awalan. Kunci cache ditambahkan di awal dalam bentuk orgName__envName__applicationName.
Proxy	Konfigurasi ProxyEndpoint digunakan sebagai awalan. Kunci cache ditambahkan di awal dalam bentuk orgName__envName__applicationName__deployedRevisionNumber__proxyEndpointName.
Target	Konfigurasi TargetEndpoint digunakan sebagai awalan. Kunci cache ditambahkan dalam bentuk orgName__envName__applicationName__deployedRevisionNumber__targetEndpointName.
Exclusive	Default. Hal ini adalah yang paling spesifik, sehingga tidak menimbulkan risiko konflik namespace dalam cache yang ditentukan. Awalan adalah salah satu dari dua bentuk: Jika kebijakan ini disertakan ke alur ProxyEndpoint, awalan akan berupa ApiProxyName_ProxyEndpointName. Jika kebijakan dilampirkan pada TargetEndpoint, awalan akan berbentuk ApiProxyName_TargetName. Kunci cache ditambahkan di awal dalam bentuk orgName__envName__applicationName__deployedRevisionNumber__proxyNameITargetName Misalnya, string lengkap mungkin terlihat seperti ini: apifactory__test__weatherapi__16__default__apiAccessToken .

Elemen <CacheContext>/<TargetName>

Menentukan nama endpoint target yang datanya di-cache.

<TargetName>endpoint_for_which_data_was_cached</TargetName>

Default:	T/A
Kehadiran:	Opsional
Jenis:	String

Atribut

Atribut	Deskripsi	Default	Kehadiran	Jenis
referensi	Variabel yang digunakan untuk mendapatkan nilai. Tidak boleh digunakan jika elemen ini berisi nilai literal.	T/A	Opsional	String

Catatan penggunaan

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

Untuk informasi selengkapnya tentang mengonfigurasi cache, lihat Cache tujuan umum. Untuk informasi selengkapnya tentang penyimpanan data pokok, lihat Internal cache.

Kode error

Bagian ini menjelaskan pesan error dan variabel alur yang ditetapkan saat kebijakan ini memicu error. Informasi ini penting untuk diketahui apakah Anda sedang mengembangkan aturan fault untuk proxy. Untuk mempelajari lebih lanjut, lihat Yang perlu Anda ketahui tentang error kebijakan dan Menangani kesalahan.

Awalan kode error

T/A

Error runtime

Kebijakan ini tidak menampilkan error runtime apa pun.

Error saat deployment

Error ini dapat terjadi saat Anda men-deploy proxy yang berisi kebijakan ini.

Tips: Perlu bantuan untuk mengatasi error? Klik di kolom Perbaiki untuk mengetahui informasi pemecahan masalah selengkapnya.

Nama error	Penyebab	Perbaikan
InvalidCacheResourceReference	Error ini terjadi jika elemen <CacheResource> dalam kebijakan InvalidateCache disetel ke nama yang tidak ada di lingkungan tempat proxy API di-deploy.
CacheNotFound	Error ini terjadi jika cache tertentu yang disebutkan dalam pesan error tidak dibuat pada komponen Pemroses Pesan tertentu.

Variabel kesalahan

T/A

Contoh respons error

T/A