خط مشی PopulateCache

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

نحوه نوشتن مقادیر کش شده در زمان اجرا را پیکربندی می کند.

خط‌مشی Populate Cache برای نوشتن ورودی‌ها در یک حافظه پنهان کوتاه‌مدت با هدف کلی طراحی شده است. این در ارتباط با سیاست جستجوی حافظه پنهان (برای خواندن ورودی های حافظه پنهان) و خط مشی Invalidate Cache (برای بی اعتبار کردن ورودی ها) استفاده می شود.

برای ذخیره پاسخ های منابع پشتیبان، به خط مشی کش پاسخ مراجعه کنید.

مرجع عنصر

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

<PopulateCache async="false" continueOnError="false" enabled="true" name="Populate-Cache-1">
    <DisplayName>Populate Cache 1</DisplayName>
    <Properties/>
    <CacheKey>
        <Prefix/>
        <KeyFragment ref=""/>
    </CacheKey>
    <!-- Omit this element if you're using the included shared cache. -->
    <CacheResource/>
    <Scope>Exclusive</Scope>
    <ExpirySettings>
        <TimeoutInSeconds>300</TimeoutInSeconds>
    </ExpirySettings>
    <Source>flowVar</Source>
</PopulateCache>

ویژگی های <PopulateCache>

جدول زیر ویژگی هایی را توصیف می کند که برای همه عناصر اصلی خط مشی مشترک هستند:

عنصر <DisplayName>

علاوه بر ویژگی name برای برچسب‌گذاری خط‌مشی در ویرایشگر پروکسی رابط کاربری مدیریت با نامی متفاوت و به زبان طبیعی، از آن استفاده کنید.

<DisplayName>Policy Display Name</DisplayName>

عنصر <CacheKey>

یک اشاره گر منحصر به فرد را برای یک قطعه داده ذخیره شده در حافظه پنهان پیکربندی می کند.

اندازه کلیدهای کش به 2 کیلوبایت محدود شده است.

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

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

اگر این خط‌مشی (و خط‌مشی‌های LookupCache و InvalidateCache مربوطه شما) از حافظه پنهان مشترک همراه استفاده می‌کند، این عنصر را به‌طور کامل حذف کنید.

<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> استفاده می کنید. برای اطلاعات بیشتر، به کار با کلیدهای حافظه پنهان مراجعه کنید.

عنصر <ExpirySettings>

مشخص می کند که یک ورودی حافظه پنهان چه زمانی باید منقضی شود. در صورت وجود، <TimeoutInSeconds> هر دو <TimeOfDay> و <ExpiryDate> را لغو می کند.

<ExpirySettings>
  <!-- use exactly one of the following child elements -->
  <TimeoutInSeconds ref="duration_variable">seconds_until_expiration</TimeoutInSeconds>
  <ExpiryDate ref="date_variable">expiration_date</ExpiryDate>
  <TimeOfDay ref="time_variable">expiration_time</TimeOfDay>
</ExpirySettings>

عناصر فرزند <ExpirySettings>

دقیقاً از یک عنصر فرزند استفاده کنید. جدول زیر توضیحاتی از عناصر فرزند <ExpirySettings> ارائه می دهد:

<ExpirySettings>
  <TimeoutInSeconds ref="var-containing-duration">expiry</TimeoutInSeconds>
</ExpirySettings>

<ExpirySettings>
  <ExpiryDate ref="var-containing-date">expiry</ExpiryDate>
</ExpirySettings>

<ExpirySettings>
  <TimeOfDay ref="var-containing-time">expiry</TimeOfDay>
</ExpirySettings>

شما باید فقط یکی از عناصر فرزند ممکن را مشخص کنید. اگر چندین عنصر را مشخص کنید، ترتیب اولویت به این صورت است: TimeoutInSeconds ، ExpiryDate ، TimeOfDay .

با هر یک از عناصر فرزند فوق در <ExpirySettings> ، اگر ویژگی ref اختیاری را در عنصر فرزند مشخص کنید، خط مشی مقدار انقضا را از متغیر زمینه نامگذاری شده بازیابی می کند. اگر متغیر تعریف نشده باشد، خط مشی از مقدار متن تحت اللفظی عنصر فرزند استفاده می کند.

عنصر <Scope>

زمانی که عنصر <Prefix> در عنصر <CacheKey> ارائه نشده باشد، شمارش برای ساختن یک پیشوند برای یک کلید کش استفاده می شود.

<Scope>scope_enumeration</Scope>

تنظیم <Scope> یک کلید حافظه پنهان را تعیین می کند که با توجه به مقدار <Scope> از قبل اضافه می شود. به عنوان مثال، هنگامی که scope روی Exclusive تنظیم شود، یک کلید حافظه پنهان به شکل زیر است:

orgName__envName__apiProxyName__deployedRevisionNumber__proxy|TargetName__ [ serializedCacheKey ]

اگر یک عنصر <Prefix> در <CacheKey> وجود داشته باشد، جایگزین مقدار عنصر <Scope> می شود. مقادیر معتبر شامل شمارش های زیر است.

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

ارزش های قابل قبول

apifactory__test__weatherapi__16__default__apiAccessToken

عنصر <منبع>

متغیری را مشخص می کند که مقدار آن باید در حافظه پنهان نوشته شود.

<Source>source_variable</Source>

نکات استفاده

از این خط‌مشی برای ذخیره‌سازی با هدف عمومی استفاده کنید. در زمان اجرا، خط مشی <PopulateCache> داده ها را از متغیری که در عنصر <Source> مشخص کرده اید، به حافظه پنهانی که در عنصر <CacheResource> مشخص کرده اید می نویسد. می توانید از عناصر <CacheKey> ، <Scope> و <Prefix> برای تعیین کلیدی استفاده کنید که می توانید از سیاست <LookupCache> برای بازیابی مقدار استفاده کنید. از عنصر <ExpirySettings> برای پیکربندی زمان منقضی شدن مقدار حافظه پنهان استفاده کنید.

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

محدودیت‌های حافظه پنهان : محدودیت‌های حافظه پنهان اعمال می‌شود، مانند اندازه نام و مقدار، تعداد کل حافظه‌های پنهان، تعداد موارد موجود در حافظه پنهان و انقضا.

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

درباره رمزگذاری کش

Edge for Public Cloud: کش فقط در سازمان‌های دارای PCI و HIPAA رمزگذاری می‌شود. رمزگذاری برای آن سازمان ها در حین تهیه سازمان پیکربندی می شود.

کدهای خطا

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

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

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

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

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

متغیرهای خطا

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

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

{
  "fault": {
    "faultstring": "[entry] can not be cached. Only serializable entries are cached.",
    "detail": {
      "errorcode": "steps.populatecache.EntryCannotBeCached"
    }
  }
}

مثال قانون خطا

<FaultRule name="Populate Cache Fault">
    <Step>
        <Name>AM-EntryCannotBeCached</Name>
        <Condition>(fault.name Matches "EntryCannotBeCached") </Condition>
    </Step>
    <Condition>(populatecache.POP-CACHE-1.failed = true) </Condition>
</FaultRule>