Anda sedang melihat dokumentasi Apigee Edge.
Buka
dokumentasi Apigee X. info
Mengonfigurasi cara nilai yang di-cache akan dihapus permanen dari cache.
Kebijakan ini ditujukan untuk digunakan dalam cache jangka pendek untuk tujuan umum. Ini digunakan bersama dengan Kebijakan Pengisian Cache (untuk menulis entri) dan kebijakan Cache Lookup (untuk membaca entri cache).
Untuk menyimpan respons resource backend dalam cache, lihat kebijakan Cache Respons.
Referensi elemen
Yang berikut ini mencantumkan 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>
Atribut <InvalidateCache>
Tabel berikut menjelaskan atribut yang sama untuk semua elemen induk kebijakan:
Atribut | Deskripsi | Default | Ketersediaan |
---|---|---|---|
name |
Nama internal kebijakan. Nilai atribut Atau, gunakan elemen |
T/A | Wajib |
continueOnError |
Setel ke Setel ke |
false | Opsional |
enabled |
Setel ke Setel ke |
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 |
---|---|
Ketersediaan | Opsional |
Jenis | String |
Elemen <CacheContext>/<APIProxyName>
Menentukan nama aplikasi yang menambahkan entri cache.
<APIProxyName>application_that_added_the_entry</APIProxyName>
Atribut
Atribut | Deskripsi | Default | Ketersediaan | Jenis |
---|---|---|---|---|
referensi | Variabel dengan nama aplikasi. | T/A | Opsional | String |
Elemen <CacheContext>
Menentukan cara membuat kunci cache saat 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 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: |
Wajib |
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 akan disimpan.
Hapus elemen ini sepenuhnya jika kebijakan ini (dan kebijakan LengkapiCache dan LookupCache Anda) menggunakan cache bersama yang disertakan.
<CacheResource>cache_to_use</CacheResource>
Default: |
T/A |
Kehadiran: |
Opsional |
Jenis: |
String |
Untuk informasi selengkapnya tentang cara mengonfigurasi cache, lihat Membuat dan mengedit cache lingkungan.
Elemen <CacheKey>/<KeyFragment>
Menentukan nilai yang harus disertakan dalam kunci cache, yang membuat namespace untuk mencocokkan permintaan dengan respons yang di-cache.
<KeyFragment ref="variable_name"/> <KeyFragment>literal_string</KeyFragment>
Default: |
T/A |
Kehadiran: |
Opsional |
Jenis: |
T/A |
Ini dapat berupa kunci (nama statis yang Anda berikan) atau nilai (entri dinamis yang ditetapkan dengan mereferensikan variabel). Semua fragmen yang ditentukan digabungkan (ditambah awalan) digabungkan untuk 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
Atribut | Deskripsi | Default | Ketersediaan | 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 |
Gunakan nilai ini, bukan <Scope>
, jika Anda ingin menentukan nilai Anda sendiri,
bukan nilai yang dienumerasi <Scope>
. Jika ditentukan,
<Prefix>
akan menambahkan nilai kunci cache untuk entri yang ditulis ke cache. Nilai elemen
<Prefix>
menggantikan nilai elemen
<Scope>
.
Anda menggunakan elemen <Prefix>
bersama dengan
<CacheKey>
dan <Scope>
. 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 | Ketersediaan | 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 yang memiliki nilai yang sama yang disetel oleh elemen <KeyFragment>
yang dikonfigurasi untuk kebijakan ini. Nilai di bagian lain dari
kunci cache, seperti di elemen <Prefix>
, tidak dipertimbangkan.
Perhatikan bahwa elemen <KeyFragment>
harus ditentukan. Jika tidak,
menyetel true untuk <PurgeChildEntries>
dapat mengakibatkan penghapusan permanen semua entri dalam
cache.
Membatalkan validasi semua entri cache dari nilai fragmen kunci yang sama dapat menjadi cara yang berguna untuk menghapus 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 menggunakan bentuk berikut saat 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 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
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 |
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 di awal formulir orgName__envName__applicationName__deployedRevisionNumber__targetEndpointName. |
Exclusive |
Default. Ini adalah hal yang paling spesifik, sehingga meminimalkan risiko benturan namespace dalam cache tertentu. Awalan adalah salah satu dari dua bentuk:
Kunci cache ditambahkan di depan formulir 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 tempat data di-cache.
<TargetName>endpoint_for_which_data_was_cached</TargetName>
Default: |
T/A |
Kehadiran: |
Opsional |
Jenis: |
String |
Atribut
Atribut | Deskripsi | Default | Ketersediaan | 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 Isi cache, kebijakan LookupCache, dan
kebijakan InvalidateCache menggunakan cache yang Anda konfigurasi atau cache bersama yang disertakan secara default. Pada umumnya, cache bersama yang mendasarinya harus memenuhi kebutuhan Anda. Untuk menggunakan cache ini,
cukup hapus elemen <CacheResource>
.
Untuk informasi selengkapnya tentang cara mengonfigurasi cache, lihat Membuat dan mengedit cache lingkungan. 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.
Nama error | Penyebab | Perbaiki |
---|---|---|
InvalidCacheResourceReference |
Error ini terjadi jika elemen <CacheResource> dalam kebijakan InvalidateCache ditetapkan ke nama yang tidak ada di lingkungan tempat proxy API di-deploy. |
build |
CacheNotFound |
Error ini terjadi jika cache tertentu yang disebutkan dalam pesan error tidak dibuat pada komponen Pemroses Pesan tertentu. | build |
Variabel kesalahan
T/A
Contoh respons error
T/A