כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של
Apigee X. מידע
בעזרת אוספים אפשר לקבץ שרתי proxy של API, יעדים או אפליקציות למפתחים, ולהגדיר ערכי סף מתאימים לכל חברי הקבוצה כדי לאבחן בעיות מהר יותר.
בקטעים הבאים מוסבר איך לנהל אוספים באמצעות ה-API.
מידע נוסף על ה-API של האוספים זמין במאמר API של אוספים.
יצירת אוספים באמצעות ה-API
כדי ליצור אוסף של שרתי proxy ל-API, שולחים בקשת POST למשאב
הבא: https://apimonitoring.enterprise.apigee.com/collections
הדוגמה הבאה מראה איך ליצור קולקציה.
curl 'https://apimonitoring.enterprise.apigee.com/collections' \ -X POST \ -H 'Accept: application/json, text/plain, */*' -H "Content-Type: application/json" \ -H "Authorization: Bearer $ACCESS_TOKEN" \ -d '{ "organization":"myorg", "name":"My Collection", "description":"My collection for critical APIs", "environment": "prod", "type": "proxy", "members":["proxy1", "proxy2"] }'
מגדירים את $ACCESS_TOKEN
לאסימון הגישה מסוג OAuth 2.0, כמו שמתואר במאמר קבלת אסימון גישה מסוג OAuth 2.0.
למידע על אפשרויות cURL המשמשות בדוגמה זו, ראה שימוש ב-cURL.
אפשר לציין את הערך type
כך: proxy
, target
או developerApp
.
לדוגמה, כדי ליצור אוסף של אפליקציות למפתחים:
curl 'https://apimonitoring.enterprise.apigee.com/collections' \ -X POST \ -H 'Accept: application/json, text/plain, */*' -H "Content-Type: application/json"\ -H "Authorization: Bearer $ACCESS_TOKEN" \ -d '{ "organization":"myorg", "name":"My Dev App Collection", "description":"My collection for critical apps", "environment": "prod", "type": "developerApp", "members":["app1", "app2"] }'
הצגת כל האוספים באמצעות ה-API
אפשר להציג את כל ההתראות וההתראות על ידי שליחת בקשת GET למשאב הבא: https://apimonitoring.enterprise.apigee.com/collections
צריך להעביר את שם הארגון באמצעות פרמטר השאילתה org
.
לדוגמה:
curl 'https://apimonitoring.enterprise.apigee.com/collections?org=myorg' -X GET -H 'Accept: application/json, text/plain, */*' -H "Authorization: Bearer $ACCESS_TOKEN"
למטה מוצגת דוגמה לתשובה:
[{ "uuid":"1234abcd", "organization":"myorg", "environment": "prod", "name":"My Collection", "type": "proxy", "members":["proxy1", "proxy2"], "description":"My collection for critical APIs", "updatedAt":"2018-07-13T16:25:15Z", "updatedBy":"joe@acme.com" }]
מגדירים את $ACCESS_TOKEN
לאסימון הגישה מסוג OAuth 2.0, כמו שמתואר במאמר קבלת אסימון גישה מסוג OAuth 2.0.
למידע על אפשרויות cURL המשמשות בדוגמה זו, ראה שימוש ב-cURL.
כדי להציג את האוסף הספציפי, מוסיפים את הערך uuid
של האוסף למשאב /collections
:
curl 'https://apimonitoring.enterprise.apigee.com/collections/1234abcd?org=myorg' -X GET -H 'Accept: application/json, text/plain, */*' -H "Authorization: Bearer $ACCESS_TOKEN"