מדיניות ניקוי המטמון

מוצג המסמך של 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 כדי להוסיף תווית למדיניות עורך proxy של ממשק משתמש לניהול עם שם אחר בשפה טבעית.

<DisplayName>Policy Display Name</DisplayName>

<CacheContext>/<APIProxyName> רכיב

מציין את שם האפליקציה שהוסיפה את רשומת המטמון.

<APIProxyName>application_that_added_the_entry</APIProxyName>

מאפיינים

<CacheContext> רכיב

מציינת איך ליצור מפתח מטמון כשערך הרכיב Prefix לא שצוינו, או כדי לנקות את רשומות המטמון שנוספו על ידי שרת proxy אחר של 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 (כלומר, קידומת מותאמת אישית) כדי לנקות רשומות מטמון נוסף על ידי שרת proxy אחר של API.

<CacheKey> רכיב

המדיניות הזו מגדירה את המיקום של מצביע ייחודי לפי חלק של נתונים ששמור במטמון.

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

<CacheKey> בונה את השם של כל פיסת נתונים המאוחסן של Google.

בזמן הריצה, הערכים של <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> למידע נוסף, ראו עבודה עם מפתחות מטמון.

מאפיינים

<CacheKey>/<Prefix> רכיב

מציינת ערך שישמש כקידומת של מפתח מטמון.

<Prefix>prefix_string</Prefix>

יש להשתמש בערך הזה במקום ב-<Scope> כשרוצים לציין ערך משלכם במקום ערך המספור <Scope>. אם מוגדר, <Prefix> מוסיף את הערך של מפתח המטמון לרשומות שנכתבו למטמון. א' ערך הרכיב <Prefix> מבטל את הרכיב <Scope> עם ערך מסוים.

משתמשים ברכיב <Prefix> בשילוב עם <CacheKey> וגם <Scope> למידע נוסף, ראו עבודה עם מפתחות מטמון.

<CacheContext>/<ProxyName> רכיב

מציין את השם של שרת ה-proxy שעבורו הנתונים נשמרו במטמון.

<ProxyName>proxy_for_which_data_was_cached</ProxyName>

מאפיינים

<PurgeChildEntries> רכיב

true כדי למחוק באופן סופי רשומות מטמון שחולקים את הערך שהוגדר על ידי הרכיב <KeyFragment> הוגדר למדיניות הזו. ערכים בחלקים אחרים של מפתח מטמון, כמו ברכיבי <Prefix>, לא נלקחים בחשבון.

חשוב לשים לב שצריך לציין את הרכיב <KeyFragment>. אם היא לא זהה, הגדרה של True עבור <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>

מאפיינים

הערות שימוש

שמירה במטמון למטרה כללית באמצעות מדיניות אכלוס המטמון, מדיניות LookupCache, וגם המדיניות InvalidateCache משתמשת במטמון שאתם מגדירים או במטמון משותף שנכלל על-ידי כברירת מחדל. ברוב המקרים, המטמון המשותף הבסיסי אמור לענות על הצרכים שלכם. כדי להשתמש במטמון הזה, פשוט להשמיט את הרכיב <CacheResource>.

למידע נוסף על הגדרת מטמון, ראו יצירה ועריכה של סביבה מטמון. למידע נוסף על מאגר הנתונים הבסיסי, ראו מטמון פנימי.

קודי שגיאה

בקטע הזה מתוארות הודעות השגיאה ומשתני הזרימה שמוגדרים כשהמדיניות הזו גורמת לשגיאה. חשוב לדעת אם מפתחים כללים לתקלה בשרת proxy. מידע נוסף זמין במאמר מה צריך לדעת על שגיאות מדיניות ועל טיפול בפגמים.

קידומת קוד שגיאה

לא רלוונטי

שגיאות בזמן ריצה

המדיניות הזו לא גורמת לשגיאות זמן ריצה.

שגיאות בפריסה

השגיאות האלה יכולות להתרחש כשפורסים שרת proxy שכולל את המדיניות הזו.

משתני שבר

לא רלוונטי

דוגמה לשגיאה

לא רלוונטי