צירוף והגדרה של מדיניות בקובצי XML

כרגע מוצג התיעוד של Apigee Edge.
נכנסים למסמכי התיעוד של Apigee X. מידע

אתם יכולים ליצור ולערוך כללי מדיניות באופן מקומי באמצעות הטקסט או כלי העריכה המותאמים ל-XML או סביבת הפיתוח המשולבת (IDE) מועדפים. בנושא הזה נשתמש בסוג מדיניות המכסה כדוגמה ליצירה, להגדרה, לצירוף, לפריסה ולבדיקה של כללי מדיניות.

רוב שרתי ה-proxy של ה-API אוכפים מכסה. המכסות מאפשרות לכם לשלוט בתדירות שבה אפליקציית לקוח מורשית להפעיל API בפרק זמן נתון. בדוגמה הבאה, מגדירים מדיניות מכסה שמגבילה את השימוש באפליקציות לבקשה אחת לדקה. (אולי זה לא מציאותי, אבל זו דרך פשוטה לראות את ההשפעות של המדיניות).

בהגדרת שרת 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: מציין אם המדיניות מופעלת או מושבתת. אפשר להפעיל או להשבית כללי מדיניות בזמן הריצה על ידי שינוי ההגדרה הזו. אין אכיפה של מדיניות שבה enabled מוגדרת לערך false.
• continueOnError: המדיניות הזו קובעת אם צינור עיבוד הנתונים ימשיך לעבד את ההודעה אם המדיניות תיכשל. כשאוכפים מדיניות מכסה, סביר להניח ששגיאות מציינות שחרגה מהמכסה, ולכן צריך להגדיר את המאפיין הזה כ-False.
• name: השם שנתתם למדיניות הזו. השם הזה ייחודי למופע המדיניות הזה, והוא משמש לצירוף המדיניות לתהליך העיבוד.

בדוגמה שלמעלה, הרכיבים Allow, Interval ו-TimeUnit הם ספציפיים למדיניות המכסה. הרכיבים האלה קובעים הגדרות ששירותי API אוכפים בשם API. סוגי מדיניות אחרים קובעים הגדרות משלהם. אפשר לקבל מידע נוסף בחומר העזר בנושא המדיניות.