عرض السجلّات باستخدام واجهة برمجة التطبيقات

أنت تطّلع على مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X. info

نزِّل سجلّات "مراقبة واجهة برمجة التطبيقات" لعرض البيانات الأولية المستخدَمة لاحتساب المقاييس المعروضة في لوحات بيانات "مراقبة واجهة برمجة التطبيقات". يمكنك تنزيل السجلات لنطاقات زمنية مخصّصة، وخوادم وكيلة محدّدة، ورموز حالة محدّدة، والعديد من المتغيّرات الأخرى.

ملاحظة: لا تعرض طلبات البيانات من واجهة برمجة التطبيقات Logs API تلقائيًا سوى النتائج التي تتضمّن رموز الحالة 4xx و5xx، وليس الرمز 2xx. ويتم ذلك بهدف حصر عدد النتائج، لأنّ معظم النتائج لها رمز الحالة 2xx. للحصول على نتائج تتضمّن رمز الحالة 2xx، أضِف status=2xx إلى الطلب. على سبيل المثال: https://apimonitoring.enterprise.apigee.com/logs?status=2xx.

توضّح الأقسام التالية كيفية إدارة السجلات باستخدام واجهة برمجة التطبيقات:

اطّلِع على Logs API للحصول على مزيد من المعلومات عن واجهة برمجة التطبيقات Logs API.

للحصول على معلومات عن خيارات cURL المستخدَمة في هذه الأمثلة، اطّلِع على استخدام cURL.

تنزيل السجلات لمؤسسة وبيئة

يمكنك تنزيل السجلات لمؤسّسة وبيئة معيّنتين باستخدام Logs API:

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

يجب إدخال اسم المؤسسة والبيئة باستخدام مَعلمتَي طلب البحث org و env.

تعرض واجهة برمجة التطبيقات تلقائيًا آخر 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"

تحتوي واجهة برمجة التطبيقات على العديد من مَعلمات طلب البحث الاختيارية. على سبيل المثال، للاطّلاع على سجلات خادم وكيل يحمل الاسم 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. يمكنك ضبطه بقيمة 1000 كحد أقصى:

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.

إدراج الخوادم الوكيلة المرتبطة بالمضيف الظاهري والمسار الأساسي

يتيح لك المضيف الافتراضي على Edge Router تحديد اسم نطاق وبروتوكول مثل HTTP/HTTPS ورقم منفذ. على سبيل المثال، يمكنك تحديد مضيف افتراضي على جهاز توجيه Edge Router باستخدام الإعدادات التالية:

  • العنوان البديل للمضيف = apis.acme.com
  • port = 443
  • تم تفعيل TLS

استنادًا إلى هذه الإعدادات، يستخدم طلب خادم وكيل لواجهة برمجة التطبيقات المرتبط بهذا المضيف الظاهري النموذج التالي:

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

المكان:

  • يتمّ تحديد proxy-base-path عند إنشاء وكيل لواجهة برمجة التطبيقات، وهو فريد لكل وكيل لواجهة برمجة التطبيقات.
  • مسار-المورد هو مسار إلى مورد يمكن الوصول إليه من خلال خادم وكيل واجهة برمجة التطبيقات.

لمزيد من المعلومات عن المضيفين الظاهريين، يمكنك الاطّلاع على لمحة عن المضيفين الظاهريين.

نزِّل قائمة بروتوكولات واجهة برمجة التطبيقات الوكيلة المرتبطة بمضيف افتراضي معيّن و مسار أساسي من خلال إرسال طلب GET إلى المرجع التالي لواجهة برمجة التطبيقات Logs API:

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

يجب تمرير اسم المؤسسة والبيئة باستخدام مَعلمتَي طلب البحث org و env بالإضافة إلى عنوان URL المرتبط بالمضيف الافتراضي والمسار الأساسي.

على سبيل المثال، يعرض طلب البيانات التالي من واجهة برمجة التطبيقات الخوادم الوكيلة المرتبطة بال مضيف افتراضي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.