خط مشی InvalidateCache

شما در حال مشاهده مستندات Apigee Edge هستید.
به مستندات Apigee X مراجعه کنید . اطلاعات

نحوه‌ی پاک شدن مقادیر ذخیره شده در حافظه‌ی پنهان (cache) را پیکربندی می‌کند.

این خط‌مشی برای استفاده در ذخیره‌سازی کوتاه‌مدت و عمومی در نظر گرفته شده است. این خط‌مشی همراه با خط‌مشی Populate Cache (برای نوشتن ورودی‌ها) و خط‌مشی Lookup Cache (برای خواندن ورودی‌های حافظه پنهان) استفاده می‌شود.

برای ذخیره پاسخ‌های منابع backend، به سیاست ذخیره پاسخ (Response Cache) مراجعه کنید.

مرجع عنصر

در زیر عناصری که می‌توانید در این سیاست پیکربندی کنید، فهرست شده‌اند.

<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 برای برچسب‌گذاری خط‌مشی در ویرایشگر پروکسی رابط کاربری مدیریت با نامی متفاوت و به زبان طبیعی، از آن استفاده کنید.

<DisplayName>Policy Display Name</DisplayName>

عنصر <CacheContext>/<APIProxyName>

نام برنامه‌ای که ورودی کش را اضافه کرده است را مشخص می‌کند.

<APIProxyName>application_that_added_the_entry</APIProxyName>

ویژگی‌ها

عنصر <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>

مقداری را مشخص می‌کند که باید در کلید حافظه پنهان (cache key) گنجانده شود و یک فضای نام برای تطبیق درخواست‌ها با پاسخ‌های ذخیره شده در حافظه پنهان ایجاد می‌کند.

<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> مقدار کلید cache را برای ورودی‌های نوشته شده در cache به ابتدای آن اضافه می‌کند. مقدار عنصر <Prefix> مقدار عنصر <Scope> را لغو می‌کند.

شما از عنصر <Prefix> به همراه <CacheKey> و <Scope> استفاده می‌کنید. برای اطلاعات بیشتر، به بخش کار با کلیدهای حافظه پنهان مراجعه کنید.

عنصر <CacheContext>/<ProxyName>

نام پروکسی که داده‌ها برای آن ذخیره شده‌اند را مشخص می‌کند.

<ProxyName>proxy_for_which_data_was_cached</ProxyName>

ویژگی‌ها

عنصر <PurgeChildEntries>

برای پاک کردن ورودی‌های حافظه پنهان که مقدار تنظیم‌شده توسط عنصر <KeyFragment> پیکربندی‌شده برای این خط‌مشی را به اشتراک می‌گذارند، true وارد کنید. مقادیر موجود در سایر بخش‌های کلید حافظه پنهان، مانند عناصر <Prefix> ، در نظر گرفته نمی‌شوند.

توجه داشته باشید که عنصر <KeyFragment> باید مشخص شده باشد. در غیر این صورت، تنظیم مقدار true برای <PurgeChildEntries> می‌تواند منجر به پاک شدن تمام ورودی‌های موجود در حافظه پنهان شود.

نامعتبر کردن تمام ورودی‌های کش با مقدار قطعه کلید یکسان می‌تواند راهی مفید برای پاک کردن همزمان چندین ورودی مرتبط باشد.

<PurgeChildEntries>true_to_purge_child_entries</PurgeChildEntries>

عنصر <scope>

شمارشی (Enumeration) برای ساخت پیشوند برای کلید حافظه پنهان (cache key) استفاده می‌شود، زمانی که عنصر <Prefix> در عنصر <CacheKey> ارائه نشده باشد.

<Scope>scope_enumeration</Scope>

تنظیم <Scope> یک کلید cache را تعیین می‌کند که مطابق با مقدار <Scope> اضافه می‌شود. برای مثال، وقتی scope روی Exclusive تنظیم شده باشد، یک کلید cache به شکل زیر خواهد بود:

orgName__envName__ application Name__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>

ویژگی‌ها

یادداشت‌های استفاده

ذخیره سازی عمومی با استفاده از سیاست Populate Cache ، سیاست LookupCache و سیاست InvalidateCache یا از یک حافظه پنهان که شما پیکربندی می‌کنید یا از یک حافظه پنهان مشترک که به طور پیش‌فرض در آن گنجانده شده است، استفاده می‌کند. در بیشتر موارد، حافظه پنهان مشترک زیربنایی باید نیازهای شما را برآورده کند. برای استفاده از این حافظه پنهان، کافیست عنصر <CacheResource> را حذف کنید.

برای اطلاعات بیشتر در مورد پیکربندی حافظه‌های پنهان، به ایجاد و ویرایش حافظه پنهان محیطی مراجعه کنید. برای اطلاعات بیشتر در مورد محل ذخیره داده اصلی، به بخش‌های داخلی حافظه پنهان مراجعه کنید.

کدهای خطا

این بخش پیام‌های خطا و متغیرهای جریانی را توضیح می‌دهد که وقتی این خط‌مشی خطا را راه‌اندازی می‌کند، تنظیم می‌شود. این اطلاعات مهم است که بدانید آیا در حال ایجاد قوانین خطا برای یک پروکسی هستید. برای کسب اطلاعات بیشتر، آنچه را که باید در مورد خطاهای خط مشی و مدیریت خطاها بدانید را ببینید.

پیشوند کد خطا

N/A

خطاهای زمان اجرا

این سیاست هیچ گونه خطای زمان اجرا ایجاد نمی کند.

خطاهای استقرار

این خطاها ممکن است زمانی رخ دهند که یک پروکسی حاوی این خط مشی را مستقر می کنید.

متغیرهای خطا

N/A

نمونه پاسخ خطا

N/A