שימוש ב-API Monitoring Management API

אתם צופים במסמכי העזרה של Apigee Edge.
כניסה למסמכי העזרה של Apigee X. info

אפשר להשתמש ב-API Management API של API Monitoring כדי לבצע את המשימות הבאות:

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

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

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

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

שימוש ב-curl

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

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

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

--data @filename

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

--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 באסימון גישה ובאסימון רענון, שבאמצעותם תוכלו לבצע קריאות מאובטחות ל-API של Apigee Edge. אחרי שמקבלים אסימון, לא צריך להחליף את פרטי הכניסה שוב עד שתוקף האסימון יפוג. אסימון הרענון מאפשר לכם לשמור את 'הסשן' שלכם עם השרת פעיל למשך זמן ארוך יותר בלי לספק את פרטי הכניסה. מידע נוסף על אסימוני גישה זמין במאמר שימוש ב-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" 
   ...