דף זה תורגם על ידי Cloud Translation API.

אחזור וסינון של מדדים של מאפיין משירותי Apigee Analytics

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

נתיב הבסיס של פלטפורמת ה-API: https://api.enterprise.apigee.com/v1/o/{org_name}

נתיב המשאב של ה-API: /environments/{env_name}/stats/{dimension_name}

תיאור: שימוש בשיטת GET כדי לאחזר מדדים של מאפיין

פועל:	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`

מסננים לדוגמה

הערה: חובה להוסיף פילטר של טקסט בין מירכאות בודדות, לדוגמה, 'api1'. אסור להשתמש במירכאות כפולות.

תיאור	סינון של מבנה השאילתות
נתונים סטטיסטיים עבור שרתי 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	לא רלוונטי	לא
טופק	לוקחים את התוצאות 'ה-K המובילות' מתוצאות. לדוגמה, כדי להחזיר את 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" : {
    }
}

רכיב של המטען הייעודי (payload):

שם	תיאור
מטא נתונים	מטא-נתונים שמשויכים לדוח
סביבות	הסביבות בארגון שבהן נאספים הנתונים הסטטיסטיים (יש תמיכה בתווים כלליים לחיפוש * לאיסוף נתונים סטטיסטיים של סביבות שונות)
metrics	הערכים שהוחזרו עבור המאפיין שצוין
מימדים	המאפיין שמוגדר למדידה: בדוגמה הזאת api_name.
metrics	המדדים בדוח