אתם צופים במסמכי התיעוד של Apigee Edge.
כדאי לעיין במסמכי התיעוד של Apigee X. מידע
נתיב הבסיס של פלטפורמת ה-API:
https://api.enterprise.apigee.com/v1/o/{org_name}
נתיב משאב API: /environments/{env_name}/stats/{dimension_name}
תיאור: שימוש בשיטת אחזור נתונים כדי לאחזר מדדים של מאפיין
| פועל: | GET |
| אימות: | אימות בסיסי |
| סוגי מדיה: |
application/json
|
סקירה כללית: דוח נוצר באמצעות בקשת GET במשאב
/stats API, בצירוף:
- פרמטר URI אופציונלי שמגדיר את המאפיין של הדוח. ב-Apigee מוגדרת קבוצה של מאפיינים, ומתבצעת צבירה מראש של קבוצה של מדדים ביחס למאפיינים האלה. אם לא מוגדר מאפיין (כלומר, אם פרמטר ה-URI ריק), נוצר דוח לכל ממשקי ה-API שקיימים בסביבה שצוינה.
- קבוצה של פרמטרים של שאילתה שמגדירים את המדדים, טווח הזמן, מרווח הזמן והמסננים או ההתפלגות של הדוח.
dimension_name: פרמטר URI שמגדיר את הישות שעבורה צריך לאחזר את מדדי פלטפורמת ה-API. Apigee מגדיר קבוצה של מאפיינים שאפשר להשתמש בהם בדוחות. המאפיינים הנתמכים כוללים:
-
/stats/apis: שרתי proxy ל-API בארגון בפלטפורמת ה-API -
/stats/apiproducts: מוצרי API שמוגדרים בארגון -
/stats/apps: השם של אפליקציית הפיתוח ששולחת את הבקשה ל-API -
/stats/client_ip: כתובות ה-IP של אפליקציות ששולחות בקשה לממשקי API בפלטפורמת API /stats/developer_email: כתובת האימייל של מפתח שרשום בארגון בפלטפורמת ה-API-
/stats/developer_app: השם של אפליקציית הפיתוח ששולחת את הבקשה אל ה-API -
/stats/devs:מזהה המפתח הייחודי שנוצר על ידי Edge ורשום בארגון ב-API Platform -
/stats/access_token: אסימון הגישה ל-OAuth של משתמש הקצה באפליקציה
אפשר להחיל מסננים על משאבים מותאמים אישית. משאבים מותאמים אישית הם:
| סמל | פעולה |
|---|---|
in |
להכללה ברשימה |
notin |
להחרגה מרשימה |
eq |
= |
ne |
!= או |
gt |
> |
lt |
|
ge |
>= |
le |
| תיאור | סינון מבנה השאילתה |
|---|---|
| נתונים סטטיסטיים של שרתי proxy ל-API שנקראים api1 או api2 | filter=(apiproxy in 'api1','api2') |
| נתונים סטטיסטיים לכל שרתי ה-proxy של ה-API, מלבד api1 ו-api2 | filter=(apiproxy notin 'ap1','api2') |
| נתונים סטטיסטיים שבהם אין שגיאות | filter=(iserror eq 0) |
| נתונים סטטיסטיים שבהם אין הודעות שגיאה או ששם ה-proxy ל-API הוא api1 או api2 | filter=(iserror eq 1) or (apiproxy in 'api1','api2') |
| נתונים סטטיסטיים שבהם (קוד התגובה הוא 201 או 301) ו (יש שגיאות) או (שם ה-proxy ל-API הוא api1 או api2) | filter=(responsecode le 201 or responsecode eq 301) and (iserror eq 1) or
(apiproxy in 'api1','api2') |
בקשה לדוגמה:
$ curl -X GET -H "Accept:application/json" \
https://api.enterprise.apigee.com/v1/o/{org_name}/environments/{env_name}/stats/{dimension_name}?"select={metric_name}&timeRange=1/1/2013%2000:00~1/2/2013%2000:00&timeUnit=hour&sortby={metric_name}&sort=DESC&filter=(apiproxy%20in%20'weather','news')" \
-u myname:mypass
| שם | תיאור | ברירת מחדל | חובה? |
|---|---|---|---|
| בחירה | מציין את המדד שיצטבר בדוח. המדדים הנתמכים הם: message_count, error_count, total_response_time, max_response_time, min_response_time, data_exchange_size, end_point_response_time | לא רלוונטי | כן |
| timeRange | שעת ההתחלה ושעת הסיום של המרווח הרצוי. פורמט התאריך הוא MM/DD/YYYY HH:MM. לדוגמה, 1/1/2013%2000:00~1/2/2013%2000:00. הטווח המקסימלי הוא 6 חודשים | לא רלוונטי | כן |
| timeUnit | שנייה, דקה, שעה, יום, שבוע, חודש, רבעון, שנה, עשור, מאה, אלף | לא רלוונטי | כן |
| sortby | אם מציינים שני ערכים או יותר, אפשר להשתמש ב-'sortby' כדי לציין את הערך שנבחר למיון התוצאות: message_count, error_count, total_response_time, max_response_time, min_response_time, data_exchange_size, end_point_response_time | לא רלוונטי | לא |
| מיון | היקפי המיון הנתמכים הם DESC או ASC | לא רלוונטי | לא |
| topk | לוקחים את התוצאות המובילות מתוך התוצאות, למשל, כדי להחזיר את 5 התוצאות המובילות: topk=5. | לא רלוונטי | לא |
| סינון | מאפשר ניתוח מעמיק של ערכי מאפיינים ספציפיים | לא רלוונטי | לא |
| הגבלה | הגדרת המגבלה על מספר הרשומות שמוחזרות על ידי ה-API | לא רלוונטי | לא |
| לקזז | משתמשים בפרמטר offset עם limit כדי להפעיל עימוד של התוצאות. לדוגמה, כדי להציג את התוצאות 11 עד 20, צריך להגדיר את הערך של limit כ-10 ואת הערך של offset כ-10. | לא רלוונטי | לא |
{
"environments" : [ {
"dimensions" : [ {
"metrics" : [
{
"name" : "message_count",
"values" : [ {
"timestamp" : 1335241800000,
"value" : "1.0"
} ]
} ,
{
"name" : "error_count",
"values" : [ {
"timestamp" : 1335241800000,
"value" : "0.0"
} ]
}
],
"name" : "api1"
},
{
"metrics" : [
{
"name" : "message_count",
"values" : [ {
"timestamp" : 1335241800000,
"value" : "1.0"
} ]
},
{
"name" : "error_count",
"values" : [ {
"timestamp" : 1335241800000,
"value" : "0.0"
} ]
}
],
"name" : "api2"
}
],
"name" : "test"
}
],
"metaData" : {
}
}| שם | תיאור |
|---|---|
| מטא נתונים | מטא-נתונים שמשויכים לדוח |
| סביבות | סביבות בארגון שבהן הנתונים הסטטיסטיים נאספים (יש תמיכה בתו כללי מסוג * לאיסוף נתונים סטטיסטיים בין סביבות) |
| מדדים | הערכים שמוחזרים למאפיין שצוין |
| מימדים | המאפיין שהוגדר למדידה: בדוגמה הזו api_name. |
| מדדים | מדדים לדוח |