ResponseCache নীতি

আপনি Apigee Edge-এর ডকুমেন্টেশন দেখছেন।
Apigee X ডকুমেন্টেশন .info- তে যান।

এটি একটি ব্যাকএন্ড রিসোর্স থেকে ডেটা ক্যাশ করে, যার ফলে সেই রিসোর্সে অনুরোধের সংখ্যা কমে যায়। যখন অ্যাপগুলো একই URI-তে অনুরোধ পাঠায়, তখন আপনি সেই অনুরোধগুলোকে ব্যাকএন্ড সার্ভারে ফরোয়ার্ড না করে, ক্যাশ করা প্রতিক্রিয়া ফেরত দেওয়ার জন্য এই পলিসিটি ব্যবহার করতে পারেন। ResponseCache পলিসিটি ল্যাটেন্সি এবং নেটওয়ার্ক ট্র্যাফিক কমানোর মাধ্যমে আপনার API-এর পারফরম্যান্স উন্নত করতে পারে।

আপনার এপিআই দ্বারা ব্যবহৃত ব্যাকএন্ড ডেটা যখন কেবল নির্দিষ্ট সময় পর পর আপডেট করা হয়, তখন রেসপন্সক্যাশ আপনার কাছে সবচেয়ে বেশি উপযোগী মনে হতে পারে। উদাহরণস্বরূপ, ধরুন আপনার একটি এপিআই আছে যা প্রতি দশ মিনিট পর পর রিফ্রেশ হওয়া আবহাওয়ার প্রতিবেদনের ডেটা সরবরাহ করে। রিফ্রেশের মধ্যবর্তী সময়ে ক্যাশ করা রেসপন্স ফেরত দেওয়ার জন্য রেসপন্সক্যাশ ব্যবহার করে, আপনি ব্যাকএন্ডে পৌঁছানো রিকোয়েস্টের সংখ্যা কমাতে পারেন। এর ফলে নেটওয়ার্ক হপের সংখ্যাও কমে যায়।

সাধারণ স্বল্পমেয়াদী ক্যাশিংয়ের জন্য Populate Cache পলিসি ব্যবহার করার কথা বিবেচনা করা যেতে পারে। এই পলিসিটি Lookup Cache পলিসি (ক্যাশ এন্ট্রি পড়ার জন্য) এবং Invalidate Cache পলিসি (এন্ট্রি বাতিল করার জন্য) এর সাথে একত্রে ব্যবহৃত হয়।

নমুনা

http://{org_name}-test.apigee.net/weather/forecastrss?w=23424778

<ResponseCache name="ResponseCache">
    <CacheKey>
        <KeyFragment ref="request.queryparam.w" />
    </CacheKey>
    <ExpirySettings>
        <TimeoutInSeconds>600</TimeoutInSeconds>
    </ExpirySettings>
</ResponseCache>

http://{org_name}-test.apigee.net/weather/forecastrss?w=23424778

'http://{org_name}-test.apigee.net/weather/forecastrss?w=23424778' -H "bypass-cache:true"

<ResponseCache name="ResponseCache">
    <CacheKey>
        <KeyFragment ref="request.queryparam.w" />
    </CacheKey>
    <!-- Explicitly refresh the cached response -->
    <SkipCacheLookup>request.header.bypass-cache = "true"</SkipCacheLookup>
    <ExpirySettings>
        <TimeoutInSeconds>600</TimeoutInSeconds>
    </ExpirySettings>
</ResponseCache>

উপাদান রেফারেন্স

এলিমেন্ট রেফারেন্সটি পলিসির উপাদান এবং অ্যাট্রিবিউটগুলো বর্ণনা করে।

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ResponseCache async="false" continueOnError="false" enabled="true" name="Response-Cache-1">
    <DisplayName>Response Cache 1</DisplayName>
    <Properties/>
    <CacheKey>
        <Prefix/>
        <KeyFragment ref="request.uri" />
    </CacheKey>
    <Scope>Exclusive</Scope>
    <ExpirySettings>
        <ExpiryDate/>
        <TimeOfDay/>
        <TimeoutInSeconds ref="flow.variable.here">300</TimeoutInSeconds>
    </ExpirySettings>
    <CacheResource>cache_to_use</CacheResource>
    <CacheLookupTimeoutInSeconds/>
    <ExcludeErrorResponse/>
    <SkipCacheLookup/>
    <SkipCachePopulation/>
    <UseAcceptHeader/>
    <UseResponseCacheHeaders/>
</ResponseCache>

<ResponseCache> অ্যাট্রিবিউট

<ResponseCache async="false" continueOnError="false" enabled="true" name="Response-Cache-1">

নিম্নলিখিত সারণী সমস্ত নীতির মূল উপাদানগুলির জন্য সাধারণ বৈশিষ্ট্যগুলি বর্ণনা করে:

<DisplayName> উপাদান

ম্যানেজমেন্ট UI প্রক্সি এডিটরে নীতিটিকে একটি ভিন্ন, প্রাকৃতিক-ভাষা নামের সাথে লেবেল করতে name বৈশিষ্ট্য ছাড়াও ব্যবহার করুন।

<DisplayName>Policy Display Name</DisplayName>

<ক্যাশকী> উপাদান

ক্যাশে সংরক্ষিত কোনো ডেটার জন্য একটি অনন্য পয়েন্টার কনফিগার করে।

ক্যাশ কী-গুলির আকার ২ কিলোবাইটে সীমাবদ্ধ।

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

<CacheKey> ক্যাশে সংরক্ষিত প্রতিটি ডেটার নাম তৈরি করে। এই কী-টি প্রায়শই এনটিটি হেডার বা কোয়েরি প্যারাম থেকে একটি ভ্যালু ব্যবহার করে সেট করা হয়। সেই ক্ষেত্রে, এলিমেন্টের ref অ্যাট্রিবিউটে কী-ভ্যালু ধারণকারী একটি ভ্যারিয়েবল নির্দিষ্ট করা থাকে।

রানটাইমে, <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> এর সাথে একত্রে ব্যবহার করেন। আরও তথ্যের জন্য, “ক্যাশ কী নিয়ে কাজ করা” দেখুন।

<CacheLookupTimeoutInSeconds> এলিমেন্ট

কত সেকেন্ড পর একটি অসফল ক্যাশ লুকআপকে ক্যাশ মিস হিসেবে গণ্য করা হবে, তা নির্দিষ্ট করে। এমনটি ঘটলে, ফ্লোটি ক্যাশ-মিস পথ ধরে পুনরায় শুরু হয়।

<CacheLookupTimeoutInSeconds>30</CacheLookupTimeoutInSeconds>

<ক্যাশরিসোর্স> উপাদান

যে ক্যাশে বার্তাগুলি সংরক্ষণ করা হবে তা নির্দিষ্ট করে। অন্তর্ভুক্ত শেয়ার্ড ক্যাশে ব্যবহার করতে এই উপাদানটি বাদ দিন। আপনি যদি ক্যাশে থাকা এন্ট্রিগুলি প্রশাসনিকভাবে মুছে ফেলতে চান, তবে আপনাকে নামসহ একটি CacheResource নির্দিষ্ট করতে হবে। এ বিষয়ে আরও জানতে, ক্যাশেস দেখুন।

<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> এর সাথে একত্রে ব্যবহার করেন। আরও তথ্যের জন্য, “ক্যাশ কী নিয়ে কাজ করা” দেখুন।

বৈশিষ্ট্য

<ক্যাশকী>/<প্রিফিক্স> উপাদান

ক্যাশ কী প্রিফিক্স হিসেবে ব্যবহার করার জন্য একটি মান নির্দিষ্ট করে।

<Prefix>prefix_string</Prefix>

যখন আপনি <Scope> দ্বারা তালিকাভুক্ত কোনো মানের পরিবর্তে আপনার নিজস্ব মান নির্দিষ্ট করতে চান, তখন <Scope> -এর বদলে এই মানটি ব্যবহার করুন। যদি সংজ্ঞায়িত করা থাকে, তাহলে <Prefix> ক্যাশে লেখা এন্ট্রিগুলির শুরুতে ক্যাশে কী-এর মান যুক্ত করে। একটি <Prefix> এলিমেন্টের মান একটি <Scope> এলিমেন্টের মানকে ওভাররাইড করে।

আপনি <Prefix> এলিমেন্টটি <CacheKey> এবং <Scope> এর সাথে একত্রে ব্যবহার করেন। আরও তথ্যের জন্য, “Working with cache keys” দেখুন।

<ExcludeErrorResponse> উপাদান

বর্তমানে, ডিফল্টরূপে, এই পলিসিটি যেকোনো সম্ভাব্য স্ট্যাটাস কোডসহ HTTP রেসপন্স ক্যাশ করে। এর মানে হলো, সফল এবং ত্রুটিপূর্ণ উভয় ধরনের রেসপন্সই ক্যাশ করা হয়। উদাহরণস্বরূপ, 2xx এবং 3xx উভয় স্ট্যাটাস কোডযুক্ত রেসপন্স ডিফল্টরূপে ক্যাশ করা হয়।

আপনি যদি HTTP ত্রুটি স্ট্যাটাস কোড সহ টার্গেট রেসপন্স ক্যাশ করতে না চান, তাহলে এই এলিমেন্টটি ' true সেট করুন; এই এলিমেন্টটি 'true' হলে শুধুমাত্র 200 থেকে 205 স্ট্যাটাস কোডযুক্ত রেসপন্সগুলোই ক্যাশ করা হবে। Edge শুধুমাত্র এই HTTP স্ট্যাটাস কোডগুলোকেই 'সফল' কোড হিসেবে গণ্য করে, এবং আপনি এই সম্পর্কটি পরিবর্তন করতে পারবেন না।

রেসপন্স ক্যাশ প্যাটার্নগুলোর মধ্যে কোনগুলোতে এই এলিমেন্টটি উপযোগী, সে বিষয়ে আলোচনার জন্য এই কমিউনিটি পোস্টটি দেখুন।

দ্রষ্টব্য: ভবিষ্যতের কোনো রিলিজে (যা পরে নির্ধারণ করা হবে), এই এলিমেন্টের ডিফল্ট সেটিং পরিবর্তন করে 'true' করা হবে। বিস্তারিত জানতে Apigee রিলিজ নোট দেখুন।

<ExcludeErrorResponse>true</ExcludeErrorResponse>

<ExpirySettings> উপাদান

একটি ক্যাশ এন্ট্রির মেয়াদ কখন শেষ হবে তা নির্দিষ্ট করে। এটি উপস্থিত থাকলে, <TimeoutInSeconds> <TimeOfDay> এবং <ExpiryDate> উভয়কেই ওভাররাইড করে।

<ExpirySettings>
  <TimeOfDay ref="time_variable">expiration_time</TimeOfDay>
  <TimeoutInSeconds ref="duration_variable">seconds_until_expiration</TimeoutInSeconds>
  <ExpiryDate ref="date_variable">expiration_date</ExpiryDate>
</ExpirySettings>

<ExpirySettings> /<ExpiryDate> এলিমেন্ট

যে তারিখে একটি ক্যাশ এন্ট্রির মেয়াদ শেষ হবে, তা নির্দিষ্ট করে। mm-dd-yyyy ফর্ম্যাটটি ব্যবহার করুন। উপস্থিত থাকলে, এই এলিমেন্টের সহোদর এলিমেন্ট, <TimeoutInSeconds> , <ExpiryDate> কে ওভাররাইড করে।

<ExpirySettings>
    <ExpiryDate ref="{date_variable}">expiration_date</ExpiryDate>
</ExpirySettings>

বৈশিষ্ট্য

<ExpiryDate ref="" />

<ExpirySettings>/<TimeOfDay> এলিমেন্ট

দিনের যে সময়ে একটি ক্যাশ এন্ট্রির মেয়াদ শেষ হবে। hh:mm:ss ফর্ম্যাটটি ব্যবহার করুন। এটি উপস্থিত থাকলে, এই এলিমেন্টের সহোদর <TimeoutInSeconds> এলিমেন্টটি <TimeOfDay> ওভাররাইড করে।

দিনের সময় HH:mm:ss ফরম্যাটে লিখুন, যেখানে HH হলো ২৪-ঘণ্টার ঘড়ির ঘণ্টা। উদাহরণস্বরূপ, বিকেল ২:৩০ এর জন্য 14:30:00।

দিনের সময়ের জন্য, ডিফল্ট লোকেল এবং টাইম জোন পরিবর্তিত হবে কোডটি কোথায় চলছে তার উপর নির্ভর করে (যা পলিসি কনফিগার করার সময় জানা সম্ভব নয়)। আপনার লোকেল কনফিগার করার তথ্যের জন্য, “একটি এনভায়রনমেন্ট ক্যাশে তৈরি এবং সম্পাদনা করা” দেখুন।

<ExpirySettings>
    <TimeOfDay ref="time_variable">expiration_time</TimeOfDay>
</ExpirySettings>

বৈশিষ্ট্য

<ExpirySettings>/<TimeoutInSec> এলিমেন্ট

যে সংখ্যক সেকেন্ড পরে একটি ক্যাশ এন্ট্রির মেয়াদ শেষ হবে।