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

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

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

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

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

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

הורדת יומנים של ארגון וסביבה ספציפיים
פירוט שרתי ה-proxy המשויכים לארגון ולסביבה

מידע נוסף על 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 מאפשר לציין שם דומיין, פרוטוקול כמו HTTP/HTTPS ומספר יציאה. לדוגמה, מגדירים מארח וירטואלי בנתב קצה עם ההגדרות הבאות:

כינוי מארח = 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 הוא הנתיב למשאב שאפשר לגשת אליו דרך שרת ה-API של שרת ה-proxy.

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

כדי להוריד את הרשימה של שרתי ה-proxy של ה-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.