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

כאן רואים את התיעוד של 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>

מאפייני <InVerifyCache>

הטבלה הבאה מפרטת מאפיינים המשותפים לכל רכיבי ההורה של המדיניות:

רכיב <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> יוצר את השם של כל חלק מהנתונים שנשמר במטמון.

בזמן הריצה, ערכי <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>

רכיב <היקף>

רשימה המשמשת ליצירת קידומת למפתח מטמון כאשר לא סופק רכיב <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>

ההגדרה קובעת את השם של נקודת הקצה (endpoint) של היעד שעבורה הנתונים נשמרו.

<TargetName>endpoint_for_which_data_was_cached</TargetName>

מאפיינים

הערות על השימוש

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

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

קודי שגיאה

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

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

לא רלוונטי

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

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

שגיאות פריסה

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

משתני כשל

לא רלוונטי

דוגמה לשגיאה

לא רלוונטי