پیوست کردن و پیکربندی خط مشی ها در فایل های XML

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

می توانید با استفاده از متن مورد علاقه خود یا ویرایشگر XML یا IDE، خط مشی ها را به صورت محلی ایجاد و ویرایش کنید. این مبحث از نوع خط مشی Quota به عنوان نمونه ای از نحوه ایجاد، پیکربندی، پیوست، استقرار و آزمایش خط مشی ها استفاده می کند.

اکثر پراکسی های API یک سهمیه را اعمال می کنند. سهمیه ها کنترلی را بر روی تعداد دفعاتی که یک برنامه مشتری مجاز به فراخوانی API در یک بازه زمانی معین است، فراهم می کند. در مثال زیر، یک خط‌مشی Quota پیکربندی شده است تا برنامه‌ها را به ۱ درخواست در دقیقه محدود کند. (اگرچه این ممکن است واقع بینانه نباشد، اما یک راه ساده برای دیدن اثرات یک سیاست ارائه می دهد.)

در پیکربندی پروکسی API، فایل‌های خط‌مشی به‌عنوان فایل‌های XML در فهرست /apiproxy/policies ذخیره می‌شوند.

به عنوان مثال، یک خط مشی از نوع Quota به نام "QuotaPolicy" می تواند به عنوان فایلی به نام QuotaPolicy.xml با محتوای زیر ایجاد شود:

<Quota enabled="true" continueOnError="false" name="QuotaPolicy">
    <Allow count="1"/>
    <Interval>1</Interval>
    <TimeUnit>minute</TimeUnit>
</Quota>

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

وقتی خط‌مشی‌هایی را در رابط کاربری مدیریت پیوست می‌کنید، سازنده پروکسی API نمونه خط‌مشی را از طرح XML برای نوع خط‌مشی که انتخاب کرده‌اید تولید می‌کند. بنابراین، ممکن است عناصری را در پیکربندی خط مشی ببینید که برای وضوح، همیشه در اسناد گنجانده نمی شوند.

همه سیاست ها ویژگی های زیر را تعریف می کنند:

  • enabled : نشان می دهد که آیا خط مشی "روشن" یا "خاموش" است. با تغییر این تنظیم می توان خط مشی ها را در زمان اجرا فعال/غیرفعال کرد. خط مشی ای که مجموعه را روی false enabled باشد، اجرا نمی شود.
  • continueOnError : تعیین می کند که آیا خط لوله باید به پردازش پیام در صورت شکست خط مشی ادامه دهد یا خیر. هنگام اجرای سیاست‌های سهمیه، اشتباهات احتمالاً نشان می‌دهند که از سهمیه فراتر رفته است، و بنابراین، این ویژگی باید روی نادرست تنظیم شود.
  • name : نامی که به این سیاست می دهید. این نام منحصر به این نمونه سیاست است و برای پیوست کردن خط مشی به جریان به عنوان مرحله پردازش استفاده می شود.

در مثال بالا، عناصر Allow ، Interval و TimeUnit مختص خط مشی Quota هستند. این عناصر تنظیماتی را ارائه می دهند که خدمات API از طرف یک API اعمال می کند. سایر انواع خط‌مشی تنظیمات خود را تعریف می‌کنند که می‌توانید در مرجع خط‌مشی با آنها آشنا شوید.