כרגע מוצג התיעוד של Apigee Edge.
נכנסים למסמכי התיעוד של
Apigee X. מידע
שימוש ב-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
|
תחילת מרווח הזמן שעבורו יש לאחזר את ההתראות. ערך ברירת המחדל הוא הזמן הנוכחי פחות שעה אחת. אפשר לקרוא הסבר למעלה לגבי הגדרת הפרמטר הזה. | פחות משעה |
to
|
סוף מרווח הזמן שעבורו יש לאחזר את ההתראות. ערך ברירת המחדל הוא השעה הנוכחית. אפשר לקרוא הסבר למעלה לגבי הגדרת הפרמטר הזה. | עכשיו |
alertId
|
לסנן את התוצאות של היסטוריית ההתראות לפי המזהה שצוין של הגדרת ההתראה. | כל מזהי ההתראות |
env
|
לסנן אירועים לפי הסביבה שצוינה. | כל הסביבות |
name
|
סינון אירועים לפי שם ההתראה שצוין. | כל שמות ההתראות |
region
|
סינון אירועים לפי האזור שצוין. | כל האזורים |
type
|
סינון אירועים לפי הסוג שצוין: alert.
|
כל הסוגים |