شما در حال مشاهده مستندات Apigee Edge هستید.
به مستندات Apigee X مراجعه کنید . اطلاعات
شما میتوانید سیاستها را به صورت محلی، با استفاده از ویرایشگر متن یا XML-aware یا IDE مورد علاقه خود ایجاد و ویرایش کنید. این مبحث از نوع سیاست Quota به عنوان نمونهای از نحوه ایجاد، پیکربندی، پیوست، استقرار و آزمایش سیاستها استفاده میکند.
اکثر پروکسیهای API سهمیهبندی را اعمال میکنند. سهمیهبندیها کنترل میکنند که یک برنامه کلاینت چند بار مجاز به فراخوانی یک API در یک بازه زمانی مشخص است. در مثال زیر، یک سیاست سهمیهبندی پیکربندی شده است تا برنامهها را به ۱ درخواست در دقیقه محدود کند. (اگرچه این ممکن است واقعبینانه نباشد، اما راهی ساده برای مشاهده اثرات یک سیاست ارائه میدهد.)
در پیکربندی پروکسی API، فایلهای Policy به صورت فایلهای 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 تولید کنید. همه سیاستها دارای برخی تنظیمات هستند که مختص نوع سیاست هستند و برخی تنظیمات که در همه سیاستها عمومی هستند.
همه سیاستها ویژگیهای زیر را تعریف میکنند:
-
enabled: نشان میدهد که آیا این خطمشی "روشن" یا "خاموش" است. با تغییر این تنظیم، میتوان خطمشیها را در زمان اجرا فعال/غیرفعال کرد. خطمشیای کهenabledآن رویfalseتنظیم شده باشد، اجرا نمیشود. -
continueOnError: تعریف میکند که آیا در صورت عدم موفقیت سیاست، خط لوله باید به پردازش پیام ادامه دهد یا خیر. هنگام اجرای سیاستهای سهمیهبندی، خطاها احتمالاً نشان میدهند که سهمیه از حد مجاز فراتر رفته است و بنابراین، این ویژگی باید روی false تنظیم شود. -
name: نامی که به این سیاست میدهید. این نام مختص این نمونه سیاست است و برای پیوست کردن سیاست به جریان به عنوان یک مرحله پردازش استفاده میشود.
در مثال بالا، عناصر Allow ، Interval و TimeUnit مختص سیاست Quota هستند. این عناصر تنظیماتی را ارائه میدهند که سرویسهای API از طرف یک API اعمال میکنند. انواع دیگر سیاستها تنظیمات خاص خود را تعریف میکنند که میتوانید در مرجع سیاستها در مورد آنها اطلاعات کسب کنید.