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

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

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

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

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

برای مثال، خط‌مشی نوع «سهمیه» به‌نام «QuotaPolicy» می‌تواند به‌عنوان فایلی به‌نام QuotaPolicy.xml با محتوای زیر ایجاد شود:

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

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

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

همه خط‌مشی‌ها مشخصه‌های زیر را تعریف می‌کنند:

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

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