นโยบายateateCache ไม่ถูกต้อง

คุณกำลังดูเอกสารประกอบ Apigee Edge
ไปที่ เอกสารประกอบเกี่ยวกับ Apigee X. ข้อมูล

กำหนดค่าวิธีล้างค่าที่แคชไว้ออกจากแคช

นโยบายนี้มีไว้ใช้เพื่อการแคชระยะสั้นที่มีวัตถุประสงค์ทั่วไป ใช้ใน ร่วมกับป้อนข้อมูล นโยบายแคช (สำหรับการเขียนรายการ) และนโยบายแคชการค้นหา (สำหรับการอ่านรายการแคช)

สำหรับการแคชคำตอบของทรัพยากรแบ็กเอนด์ โปรดดูที่ นโยบายแคชการตอบกลับ

การอ้างอิงองค์ประกอบ

รายการต่อไปนี้แสดงองค์ประกอบที่คุณสามารถกำหนดค่าในนโยบายนี้

<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> แอตทริบิวต์

ตารางต่อไปนี้อธิบายแอตทริบิวต์ทั่วไปในองค์ประกอบระดับบนสุดของนโยบายทั้งหมด

<DisplayName> องค์ประกอบ

ใช้เพิ่มเติมจากแอตทริบิวต์ name เพื่อติดป้ายกำกับนโยบายใน เครื่องมือแก้ไขพร็อกซี UI การจัดการด้วยชื่อที่เป็นภาษาธรรมชาติต่างกัน

<DisplayName>Policy Display Name</DisplayName>

<CacheContext>/<APIProxyName> องค์ประกอบ

ระบุชื่อแอปพลิเคชันที่เพิ่มรายการแคช

<APIProxyName>application_that_added_the_entry</APIProxyName>

Attributes

<CacheContext> องค์ประกอบ

ระบุวิธีสร้างคีย์แคชเมื่อค่าขององค์ประกอบ Prefix ไม่ถูกต้อง หรือเพื่อล้างรายการแคชที่เพิ่มโดยพร็อกซี API อื่น

<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>

ใช้เพื่อสร้าง CacheKey ค่าของ APIProxyName, ProxyName และ TargetName มีดังนี้ จำเป็นเมื่อไม่ได้ใช้คำนำหน้า CacheKey (ซึ่งก็คือคำนำหน้าที่กำหนดเอง) เพื่อล้างรายการแคช ที่เพิ่มโดยพร็อกซี API อื่น

<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> ดูข้อมูลเพิ่มเติมได้ที่การใช้งานคีย์แคช

<CacheResource> องค์ประกอบ

ระบุแคชที่ใช้เก็บข้อความ

ละเว้นองค์ประกอบนี้โดยสิ้นเชิงหากนโยบายนี้ (และ PopulateCache ที่เกี่ยวข้องและ นโยบาย LookupCache) กำลังใช้แคชที่ใช้ร่วมกันซึ่งรวมไว้

<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> ดูข้อมูลเพิ่มเติมได้ที่การใช้งานคีย์แคช

Attributes

<CacheKey>/<Prefix> องค์ประกอบ

ระบุค่าที่จะใช้เป็นคำนำหน้าคีย์แคช

<Prefix>prefix_string</Prefix>

ใช้ค่านี้แทน <Scope> เมื่อต้องการระบุค่าของคุณเอง แทนที่จะเป็นค่าที่แจกแจง <Scope> หากกำหนดไว้ <Prefix> เพิ่มค่าคีย์แคชไว้หน้ารายการที่เขียนลงในแคช ต ค่าองค์ประกอบ <Prefix> จะลบล้างองค์ประกอบ <Scope>

คุณใช้องค์ประกอบ <Prefix> ร่วมกับ <CacheKey> และ <Scope> ดูข้อมูลเพิ่มเติมได้ที่การใช้งานคีย์แคช

<CacheContext>/<ProxyName> องค์ประกอบ

ระบุชื่อของพร็อกซีที่เก็บข้อมูล

<ProxyName>proxy_for_which_data_was_cached</ProxyName>

Attributes

<PurgeChildEntries> องค์ประกอบ

true เพื่อลบรายการแคชที่ใช้ค่าที่แชร์โดย กำหนดค่าองค์ประกอบ <KeyFragment> สำหรับนโยบายนี้แล้ว ค่าในส่วนอื่นๆ ของ ระบบจะไม่พิจารณาคีย์แคช เช่น ในองค์ประกอบ <Prefix>

โปรดทราบว่าต้องระบุองค์ประกอบ <KeyFragment> หากไม่เป็นเช่นนั้น การตั้งค่าเป็น "จริง" สำหรับ <PurgeChildEntries> อาจทำให้รายการทั้งหมดใน แคช

การยกเลิกรายการแคชทั้งหมดของค่าส่วนย่อยคีย์เดียวกันอาจมีประโยชน์ในการ ลบรายการที่เกี่ยวข้องหลายรายการในครั้งเดียว

<PurgeChildEntries>true_to_purge_child_entries</PurgeChildEntries>

<Scope> องค์ประกอบ

การแจงนับที่ใช้เพื่อสร้างคำนำหน้าสำหรับคีย์แคชเมื่อ <Prefix> ไม่ได้ระบุองค์ประกอบในองค์ประกอบ <CacheKey>

<Scope>scope_enumeration</Scope>

การตั้งค่า <Scope> จะกำหนดคีย์แคชที่เพิ่มด้านหน้าตาม ค่า <Scope> ตัวอย่างเช่น คีย์แคชจะมีรูปแบบต่อไปนี้เมื่อ กำหนดขอบเขตเป็น Exclusive:

orgName__envName__applicationName__deployedRevisionNumber__proxy|TargetName__ [ serializedCacheKey ]

หากมีองค์ประกอบ <Prefix> ใน <CacheKey> องค์ประกอบดังกล่าว มีผลแทนค่าของเอลิเมนต์ <Scope> ค่าที่ถูกต้องจะรวมถึงการแจงนับ ที่ด้านล่าง

คุณใช้องค์ประกอบ <Scope> ร่วมกับ <CacheKey> และ <Prefix> ดูข้อมูลเพิ่มเติมได้ที่การใช้งานคีย์แคช

ค่าที่ยอมรับ

apifactory__test__weatherapi__16__default__apiAccessToken

<CacheContext>/<TargetName> องค์ประกอบ

ระบุชื่อของปลายทางเป้าหมายที่มีการแคชข้อมูลไว้

<TargetName>endpoint_for_which_data_was_cached</TargetName>

Attributes

หมายเหตุการใช้งาน

การแคชจุดประสงค์ทั่วไปโดยใช้นโยบายแคชเติม นโยบาย LookupCache และ นโยบาย "DefaultateCache" ใช้แคชที่คุณกำหนดค่าหรือแคชที่แชร์ซึ่งรวมไว้โดย "ค่าเริ่มต้น" ในกรณีส่วนใหญ่ แคชที่ใช้ร่วมกันที่สำคัญควรตรงตามความต้องการของคุณ หากต้องการใช้แคชนี้ ละเว้นเอลิเมนต์ <CacheResource> ได้เลย

โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับการกำหนดค่าแคชที่การสร้างและแก้ไขสภาพแวดล้อม แคช ดูข้อมูลเพิ่มเติมเกี่ยวกับพื้นที่เก็บข้อมูลที่สำคัญได้ที่แคชภายใน

รหัสข้อผิดพลาด

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