הצגת יומנים באמצעות ה-API

אתם צופים במסמכי העזרה של Apigee Edge.
כניסה למסמכי העזרה של Apigee X. info

אתם יכולים להוריד את היומנים של מעקב ה-API כדי לראות את הנתונים הגולמיים ששימשו לחישוב המדדים שמוצגים במרכזי הבקרה של מעקב ה-API. אפשר להוריד יומנים לפי טווחי זמן מותאמים אישית, שרתים אנונימיים ספציפיים, קודי סטטוס ספציפיים ומשתנים רבים אחרים.

הערה: כברירת מחדל, קריאות ל-Logs API מחזירות רק תוצאות עם קודי סטטוס 4xx ו-5xx, אבל לא עם קוד 2xx. המטרה של כך היא להגביל את מספר התוצאות, כי לרוב התוצאות יש קוד סטטוס 2xx. כדי לקבל תוצאות עם קוד סטטוס 2xx, מוסיפים את הערך status=2xx לבקשה. לדוגמה: https://apimonitoring.enterprise.apigee.com/logs?status=2xx.

בקטעים הבאים מוסבר איך לנהל יומנים באמצעות ה-API:

מידע נוסף על Logs API זמין במאמר Logs API.

מידע על אפשרויות ה-cURL שבהן נעשה שימוש בדוגמאות האלה זמין במאמר שימוש ב-cURL.

הורדת יומנים של ארגון וסביבה

אפשר להוריד את היומנים של ארגון וסביבה ספציפיים באמצעות Logs API:

https://apimonitoring.enterprise.apigee.com/logs

צריך להעביר את השם של הארגון והסביבה באמצעות פרמטרי השאילתה org ו-env.

כברירת מחדל, ה-API מחזיר את 10 רשומות היומן האחרונות של השעה הקודמת. לדוגמה:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

מגדירים את $ACCESS_TOKEN לאסימון הגישה מסוג OAuth 2.0, כפי שמתואר במאמר קבלת אסימון גישה מסוג OAuth 2.0.

התגובה היא מערך של רשומות ביומן בפורמט:

[   
  {
"request":"GET /v1/o/myorg/z HTTP/1.1",
    "request_length":1349,
    "request_message_id":"rrt-0623eb157b650315c-c-ne-7785-16029140-1",
    "virtual_host":"api.enterprise.apigee.com",
    "response_size":144,
    "response_time":0.551,
    "response_status":"404",
    "timestamp":"2018-08-14T17:31:07Z",
    "fault_code":"messaging.adaptors.http.flow.ErrorResponseCode",
    "fault_flow":"-",
    "fault_policy":"null/null",
    "fault_proxy":
        "/organizations/myorg/environments/prod/apiproxies/myAPI/revisions/50",
    "fault_source":"target"
  },
  …
]

משתמשים בפרמטרי השאילתה from ו-to כדי לציין טווח זמן בפורמט ISO. פורמט התאריך יכול להיות:

  • yyyy-mm-ddThh:mm:ssZ
  • yyyy-mm-ddThh:mm:ss+00:00

לדוגמה:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod&from=2018-08-13T14%3A04%3A00Z&to=2018-08-13T14%3A10%3A00Z" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

ל-API יש הרבה פרמטרים אופציונליים של שאילתות. לדוגמה, כדי להציג את היומנים של שרת proxy בשם myAPI שמייצר תגובות HTTP 404:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod&proxy=myAPI&status=404" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

כדי להחזיר יותר מ-10 רשומות ביומן, צריך להגדיר את פרמטר השאילתה limit. אפשר להגדיר ערך מקסימלי של 1,000:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod&proxy=myAPI&status=404&limit=200" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

אפשרויות נוספות מפורטות במאמר Logs API.

הצגת רשימה של שרתים proxy המשויכים למארח וירטואלי ולנתיב בסיס

מארח וירטואלי ב-Edge Router מאפשר לכם לציין שם דומיין, פרוטוקול כמו HTTP/HTTPS ומספר יציאה. לדוגמה, אפשר להגדיר מארח וירטואלי ב-Edge Router באמצעות ההגדרות הבאות:

  • host alias = apis.acme.com
  • port = 443
  • TLS מופעל

על סמך ההגדרות האלה, בקשה לשרת proxy של API שמשויך למארח הווירטואלי הזה נעשית באמצעות הטופס:

https://apis.acme.com/proxy-base-path/resource-path

כאשר:

  • proxy-base-path מוגדר כשיוצרים שרת proxy ל-API, והוא ייחודי לכל שרת proxy ל-API.
  • resource-path הוא הנתיב למשאב שאפשר לגשת אליו דרך שרת ה-proxy של ה-API.

מידע נוסף על מארחים וירטואליים זמין במאמר מידע על מארחים וירטואליים.

כדי להוריד את רשימת שרתי ה-API המחוברים לארח וירטואלי ולנתיב בסיס ספציפיים, שולחים בקשת GET למשאב הבא של Logs API:

https://apimonitoring.enterprise.apigee.com/logs/apiproxies

צריך להעביר את שם הארגון והסביבה באמצעות פרמטרי השאילתה org ו-env, וגם את ה-URI שמשויך למארח הווירטואלי ולנתיב הבסיס.

לדוגמה, קריאת ה-API הבאה מחזירה את שרתי ה-proxy שמשויכים למארח הווירטואלי http://apis.acme.com ולנתיב הבסיס /v1/perf:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs/apiproxies?org=myorg&env=prod&select=http://apis.acme.com/v1/perf" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

מגדירים את $ACCESS_TOKEN לאסימון הגישה מסוג OAuth 2.0, כפי שמתואר במאמר קבלת אסימון גישה מסוג OAuth 2.0.

אפשרויות נוספות מפורטות במאמר Logs API.