שימוש ב-API Monitoring Management API

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

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

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

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

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

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

שימוש ב-Curl

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