אתם צופים במסמכי העזרה של Apigee Edge.
כניסה למסמכי העזרה של Apigee X. info
אפשר להשתמש ב-API /metrics/events כדי לקבל את כל האירועים בארגון בפרק זמן מסוים. רשימת האירועים כוללת את כל ההתראות שזוהו על ידי Edge.
כברירת מחדל, ה-API מחזיר את כל האירועים של השעה הקודמת.
כדי לציין משך זמן אחר, משתמשים בפרמטר השאילתה from ובפרמטר השאילתה to.
הערכים של פרמטר השאילתה from ו-to תומכים בפורמטים הבאים:
now(השעה המקומית הנוכחית)-<value><unit>מציין זמן בעבר (שימו לב לקו המחבר בהתחלה):<value>– מספר שלם<unit>– יחידת זמן של:s, sec, second, m, min, minute, h, hr, hour, d, day
- תאריך בפורמט ISO, לפי אחד מהפורמטים הבאים:
yyyy-mm-ddThh:mm:ssZyyyy-mm-ddThh:mm:ss+00:00
לדוגמה:
now- -
1h -10min2019-05-13T14:04:00+00:00
רק פרמטר השאילתה org נדרש. קריאת ה-API הבאה מחזירה את כל האירועים בארגון myorg ב-12 השעות האחרונות:
curl -H "Authorization: Bearer $ACCESS_TOKEN" \ "https://apimonitoring.enterprise.apigee.com/metrics/events?org=myorg&from=-12h&to=now"
מגדירים את $ACCESS_TOKEN לאסימון הגישה מסוג OAuth 2.0, כפי שמתואר במאמר קבלת אסימון גישה מסוג OAuth 2.0. מידע על האפשרויות של curl שבהן נעשה שימוש בדוגמה הזו זמין במאמר שימוש ב-curl.
ה-API הזה תומך בפרמטרים האופציונליים הבאים של שאילתות:
| שם | תיאור | ברירת מחדל |
|---|---|---|
from
|
תחילת מרווח הזמן שבו צריך לאחזר התראות. ערך ברירת המחדל הוא השעה הנוכחית פחות שעה אחת. עיינו בתיאור שלמעלה לגבי הגדרת הפרמטר הזה. | -1h |
to
|
סיום מרווח הזמן שבו צריך לאחזר את ההתראות. ערך ברירת המחדל הוא השעה הנוכחית. עיינו בתיאור שלמעלה לגבי הגדרת הפרמטר הזה. | עכשיו |
alertId
|
סינון התוצאות של היסטוריית ההתראות לפי מזהה ההגדרה של ההתראה שצוין. | כל מזהי ההתראות |
env
|
סינון אירועים לפי הסביבה שצוינה. | כל הסביבות |
name
|
סינון אירועים לפי שם ההתראה שצוין. | כל שמות ההתראות |
region
|
סינון אירועים לפי האזור שצוין. | כל האזורים |
type
|
מסננים את האירועים לפי הסוג שצוין: alert.
|
כל הסוגים |