מוצג המסמך של Apigee Edge.
עוברים אל
מסמכי תיעוד של Apigee X. מידע
אפשר ליצור ולערוך כללי מדיניות באופן מקומי באמצעות הטקסט המועדף, או באמצעות עורך המודעות ל-XML או סביבת פיתוח משולבת (IDE). הנושא הזה משתמש בסוג המדיניות Quota כדוגמה לאופן שבו יוצרים, מגדירים, מצרפים, פורסים, וכללי מדיניות הבדיקה.
רוב שרתי ה-proxy ל-API אוכפים מכסה. מכסות מאפשרות לקבוע את התדירות שבה אפליקציית לקוח מורשה להפעיל API בפרק זמן נתון. בדוגמה הבאה, מדיניות Quota היא מוגדרת הגבלה של אפליקציות לבקשה אחת בדקה. (ייתכן שההסבר הזה לא יהיה מציאותי, מתן דרך פשוטה לראות את ההשפעות של מדיניות כלשהי).
בהגדרה של שרת proxy ל-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. הכול יש הגדרות מסוימות שהן ספציפיות לסוג המדיניות, וחלק מההגדרות כללי בכל כללי המדיניות.
כל כללי המדיניות מגדירים את המאפיינים הבאים:
enabled: מציין אם המדיניות מופעלת או "off". כללי מדיניות יכולים להיות מופעלת/מושבתת בזמן הריצה על ידי שינוי ההגדרה הזו. מדיניות שהוגדרה להenabledהערך שהוגדר לערךfalseלא נאכף.continueOnError: מגדיר אם צינור עיבוד הנתונים צריך להמשיך לעבד את אם המדיניות נכשלת. בזמן האכיפה של מדיניות המכסות, סביר להניח ששגיאות מציינות חרגתם מהמכסה, ולכן צריך להגדיר את המאפיין הזה כ-False.name: השם שאתם נותנים למדיניות הזו. השם הזה ייחודי מופע של מדיניות, והוא משמש לצירוף המדיניות לתהליך כשלב בעיבוד.
בדוגמה שלמעלה, הרכיבים Allow, Interval ו-
TimeUnit הם ספציפיים למדיניות המכסה. הרכיבים האלה מספקים הגדרות שה-API
פעולות אכיפה של שירותים מטעם ממשק API. סוגי מדיניות אחרים קובעים הגדרות משלהם, ואתם
כדי לקבל מידע נוסף, אפשר לעיין בחומר העזר בנושא מדיניות.