מוצג המסמך של 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 ב-API
/stats
מקור מידע, יחד עם:
- פרמטר אופציונלי של 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/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 | שני, דקה, שעה, יום, שבוע, חודש, רבעון, שנה, עשור, מאה, מילניום | לא רלוונטי | כן |
| Orderby, מיון | כשמציינים שני ערכי בחירה או יותר, הערך 'sortby' יכול לשמש לציון בחר משמש למיון התוצאות: message_count, error_count, total_response_time, max_response_time, min_response_time, data_exchange_size, end_point_response_time | לא רלוונטי | לא |
| מיון | היקפי המיון הנתמכים הם DESC או ASC | לא רלוונטי | לא |
| טופק | עלה על 'מספר המילים המובילות' מתוצאות מתוך תוצאות, לדוגמה, כדי להחזיר את 5 התוצאות המובילות 'topk=5'. | לא רלוונטי | לא |
| סינון | הפעלת הצגת פירוט של ערכים ספציפיים של מאפיינים | לא רלוונטי | לא |
| הגבלה | הגדרת המגבלה למספר הרשומות שה-API מחזיר | לא רלוונטי | לא |
| לקזז | שימוש בהיסט עם מגבלה כדי לאפשר חלוקה של התוצאות לדפים. לדוגמה, כדי להציג תוצאות 11-20, הגדרת המגבלה ל-10 ולהיסט ל-'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. |
| ערכים | המדדים בדוח |