שימוש ב-API Monitoring Management API

אתם צופים במסמכי התיעוד של Apigee Edge.
כדאי לעיין במסמכי התיעוד של Apigee X. מידע

אפשר להשתמש ב-API לניהול מעקב אחר API כדי לבצע את המשימות הבאות.

משימה מידע נוסף
ניהול התראות לגבי מעקב אחרי API
ניהול אוספים ב-API Monitoring
צפייה ביומנים של מעקב אחר קריאות ל-API ברמות שונות
צפייה במדדי מעקב אחר API

מכסות של קריאות ל-API

כל ממשקי ה-API של API Monitoring אוכפים מכסה שמגבילה את מספר הפעמים שאפשר לקרוא ל-API בכל דקה. לדוגמה, ב-API של יצירת אוספים יש מגבלה של שש קריאות בדקה.

לכל ממשקי ה-API יש מכסות שונות. כדי לדעת מה המגבלה של כל API, אפשר לעיין במסמכי העזרה של ה-API.

שימוש ב-curl

בדוגמאות ל-API במסמך הזה נעשה שימוש ב-curl כדי להדגים איך להשתמש ב-API Monitoring באמצעות ה-API. ‏ curl הוא כלי קוד פתוח לשורת הפקודה להעברת נתונים עם תחביר של כתובת URL, שתומך בפרוטוקולים נפוצים כמו HTTP ו-HTTPS. מידע על הורדה ושימוש ב-curl זמין בכתובת https://curl.haxx.se/.

בטבלה הבאה מפורטות האפשרויות של שורת הפקודה curl שבהן נעשה שימוש בדוגמאות.

אפשרות תיאור
-d '{}'

--data @filename

הגדרת גוף הבקשה, שמועבר ישירות או על ידי ציון שם קובץ.
-H

--header

מגדיר כותרת של בקשה. יש להעביר את הפרטים הבאים ב-request header:
  • אסימון OAuth 2.0 לאימות משתמשים באמצעות כותרת Authorization, כמו שמתואר במאמר איך מקבלים אסימון גישה מסוג OAuth 2.0.
  • סוגי התוכן שהלקוח תומך בהם באמצעות הכותרת Accept.
  • סוג התוכן של גוף הבקשה שנשלח כשיוצרים או מעדכנים משאב (POST, ‏ PATCH, ‏ PUT) באמצעות הכותרת Content-Type.
-i הצגת מידע נוסף, כמו כותרות, בתשובה.
-X מציין את סוג הבקשה (GET,‏ POST וכן הלאה).

קבלת אסימון גישה מסוג OAuth 2.0

‫Apigee Edge תומך ב-OAuth 2.0 לאימות משתמשים. באמצעות OAuth 2.0, אתם מחליפים את פרטי הכניסה שלכם ב-Apigee Edge באסימון גישה ובאסימון רענון, שבהם תוכלו להשתמש כדי לבצע קריאות מאובטחות ל-Apigee Edge API. אחרי שמקבלים אסימון, לא צריך להחליף שוב את פרטי הכניסה עד שתוקף האסימון יפוג. טוקן הרענון מאפשר לכם לשמור על ה'סשן' עם השרת פעיל למשך תקופה ארוכה יותר בלי לספק את פרטי הכניסה. מידע נוסף על אסימוני גישה זמין במאמר שימוש ב-OAuth2 לגישה ל-Management API.

באמצעות פרטי הכניסה שלכם ל-Apigee Edge, אתם יכולים לקבל אסימוני גישה ורענון מסוג OAuth 2.0 כדי לגשת למשאבים של Apigee Edge באמצעות כלי השירות get_token של Apigee.

כדי לקבל אסימון גישה מסוג OAuth 2.0:

  1. מתקינים את כלי השירות get_token. מידע על התקנת כלי השירות get_token זמין במאמר שימוש ב-get_token.

  2. מריצים את הפקודה get_token כדי לקבל אסימון גישה מסוג OAuth 2.0.

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

  3. מעתיקים את אסימון OAuth 2.0 ומאחסנים אותו במשתנה, כמו ACCESS_TOKEN: 

    export ACCESS_TOKEN=eyJhbGciOiJSUzI1NiJ9.eyJqdGkiOiI2NmQ4MTRiMC01YzZkLTQyZWUtYjlmYi05ZGVhODk5MGRiODIiLCJzdWIiOiJlZjc3YmRhMS05ZWIxLTQyZDgtODg5MC0zODQ3ODg0MzM1OWIiLCJzY29wZSI6WyJzY2ltLmVtYWlscy5yZWFkIiwicGFzc3dvcmQud3JpdGUiLCJhcHByb3ZhbHMubWUiLCJzY2ltLm1lIiwic2NpbS5pZHMucmVhZCIsIm9wZW5pZCIsIm9hdXRoLmFwcHJvdmFscyJdLCJjbGllbnRfaWQiOiJlZGdlY2xpIiwiY2lkIjoiZWRnZWNsaSIsImF6cCI6ImVkZ2VjbGkiLCJncmFudF90eXBlIjoicGFzc3dvcmQiLCJ1c2VyX2lkIjoiZWY3N2JkYTEtOWViMS00MmQ4LTg4OTAtMzg0Nzg4NDMzNTliIiwib3JpZ2luIjoidXNlcmdyaWQiLCJ1c2VyX25hbWUiOiJsbHluY2hAYXBpZ2VlLmNvbSIsImVtYWlsIjoibGx5bmNoQGFwaWdlZS5jb20iLCJyZXZfc2lnIjoiZTViZDc3NjIiLCJpYXQiOjE0NzA3NTMyMDksImV4cCI6MTQ3MDc5NjQwOSwiaXNzIjoiaHR0cHM6Ly9sb2dpbi5lMmUuYXBpZ2VlLm5ldC9vYXV0aC90b2tlbiIsInppZCI6InVhYSIsImF1ZCI6WyJzY2ltIiwicGFzc3dvcmQiLCJvcGVuaWQiLCJlZGdlY2xpIiwiYXBwcm92YWxzIiwic2NpbS5lbWFpbHMiLCJzY2ltLmlkcyIsIm9hdXRoIl19.FF3f1i9eHbBqYjnvBmt9nTtTcyNQBQRDDq2tQ3aRUAzUesLAet7qfBB9QVCvE-zVBn4BiPgRU-iturxPxRMAQ2a34-8oLvgff3x-aALBWkSwbc8PJdWTiPP9VYykoFSJtu9UIN5x0FQEQN_hyurO8D2SrS3uQKNwIyjoJPy4Bps7nb3WqJyKRfXAzf8UptdN7XE0TVqTyBcZGT3OQ2Was0VPfe_dr-wIrywvjNf6FczjdktB1lpKJ2oRXx1n8PuK5FhOQ4wE9VeSsNsMHVcGvJ5W6Tvi61fo2h1w1d4AKvGdERzuVf_XWN00mtcgwsUAuXV0r5H_i3vxcMuUym1XOg

כשקוראים ל-API Monitoring API, מעבירים את טוקן הגישה של OAuth 2.0 בכותרת HTTP באמצעות הכותרת Authorization. לדוגמה:


curl -X GET "https://apimonitoring.enterprise.apigee.com/alerts?org=myorg"
   -H "Authorization: Bearer $ACCESS_TOKEN" 
   ...