راهنمای استفاده از API جدید Purge
زمانی که نیاز دارید یک آدرس cache شده را ابطال (invalidate) کنید تا cache مورد نظر حذف شود و محتوای جدید از سرور origin مجددا دریافت شود، میتوایند از Purge API ستون استفاده کنید. در این مستند نحوه استفاده از نسخه دوم این API توضیح داده شده است.
برای این کار لازم است یک درخواست با متد POST به آدرس زیر ارسال کنید:
همچنین لازم است که Headers زیر را برای این درخواست تنظیم کنید:
برای دریافت <user-bepa-token> طبق راهنمایی که در پایان این مستند تحت عنوان پیوست۱ آورده شده است، عمل کنید.
همراه با این درخواست باید یک body با فرمت JSON و به شکل زیر ارسال شود:
در اینجا:
- مقدار wsid را طبق راهنمایی که در پایان تحت عنوان پیوست۲ آورده شده است، جایگزین کنید.
- مقدار hostname برابر با نام دامنهای است که برای آن CDN مورد نظر را ساختهاید.
- مقدار subdomains لیستی از نام زیردامنههاست که توسط CDN مورد نظر پاسخ داده میشوند.
- مقدار paths لیستی از آدرسهاست که باید Purge شوند.
نکته مهم
این درخواست فقط باید توسط کاربری ارسال شود که مجوز انجام Purge را دارد. برای تخصیص مجوز میتوانید طبق راهنمایی که در پایان این مستند، تحت عنوان پیوست۳ آورده شده است، عمل کنید.
برای مثال فرض کنید که برای دامنه domain.ir یک CDN ساختهاید و همچنین درخواستهای www.domain.ir نیز از طریق این CDN پاسخ داده میشوند. (مثلا از طریق تعریف یک رکورد CNAME برای www که به آدرس دامنه بدون www ریزالو میشود). در این مثال مقدار Body میتواند به شکل زیر باشد:
در اینجا:
- عملیات Purge برای دو دامنه domain.ir و www.domain.ir اجرا میشود. دقت کنید که نباید نام دامنه اصلی (hostname) را مجددا در لیست subdomains به نام زیردامنهها اضافه کنید.
- تمامی فایلهایی که در آدرس /scripts قرار دارند Purge میشوند. برای این کار از کاراکتر ✻ استفاده شده است. دقت کنید که از ✻ فقط بهعنوان آخرین کاراکتر در آدرسدهی میتوانید استفاده کنید.
- تک فایل /data/image.png حذف میشود.
برای ارسال این درخواست میتوانید از curl استفاده کنید:
در پاسخ یکی از Status Codes زیر ارسال خواهد شد:
- پاسخ 201: زمانی که درخواست Purge با موفقیت ثبت میشود. دقت کنید که فرایند Purge یک فرایند زمانبر است و ثبت درخواست به معنی انجام آن در لحظه نیست.
- پاسخ 400: زمانی که Body ارسالی قابل پردازش نباشد.
- پاسخ 401: زمانی که توکن IAM کاربر در هدر Authorization به درستی تنظیم نشده باشد.
- پاسخ 403: زمانی که کاربر مجاز به انجام Purge نباشد (مراجعه به پیوست۳).
پاسخ 502: زمانی که ارتباط با سرور IAM دچار مشکل شده باشد. در این مواقع درخواست خود را بعد از مدتی تکرار کنید و در صورت مشاهده مجدد با پشتیبانی تماس بگیرید.
۱- روی دکمه تنظیمات کاربری 👤 کلیک کنید.
۲- روی نام خود کلیک کنید تا صفحهی پروفایل باز شود.
۳- در بخش "توکنهای کاربر" روی دکمه "افزودن توکن کاربر" کلیک کنید. سپس یک نام دلخواه برای توکن انتخاب نموده و توکن جدید را اضافه کنید.
۴- در نهایت توکن ساخته شده را کپی کنید. دقت کنید که این توکن در آینده به شما نشان داده نمیشود، پس آن را در یک محل امن ذخیره کنید. توجه کنید که دارنده این توکن میتواند از طرف شما تغییراتی را در تنظیمات محصولات ایجاد کند، بنابراین آن را در اختیار دیگران قرار ندهید.
۱- روی دکمه ☰ کلیک کنید و از منوی باز شده گزینه "تنظیمات IAM" را انتخاب کنید.
۲- در صفحه "تنظیمات IAM" روی گزینه "فضای کاری" کلیک کنید.
۳- در لیست فضاهای کاری مقدار id در ستون "شناسه" قابل مشاهده است.
۱- روی دکمه ☰ کلیک کنید و از منوی باز شده گزینه "تنظیمات IAM" را انتخاب کنید.
۲- در صفحه "تنظیمات IAM" روی گزینه "نقشها" کلیک کنید.
۳- در قسمت "نقشهای از پیش تعریف شده" عبارت "purge" را جستجو کنید و سپس در لیست روی نام نقش "cdn-purger" کلیک کنید تا تنظیمات آن نمایش داده شود. اگر نمیتوانید روی این نقش کلیک کنید یعنی مجوز لازم برای تخصیص نقش را ندارید.
۴- در قسمت "کاربرها" روی دکمه "اختصاص دادن کاربر" کلیک کنید و سپس کاربر مورد نظر را به نقش مربوطه اضافه کنید. این تغییر ممکن است مدت کوتاهی طول بکشد تا اعمال شود. درصورتی که بعد از گذشت چند دقیقه تغییر مورد نظر اعمال نشد لطفا با پشتیبانی تماس بگیرید.