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

أنت الآن بصدد الاطّلاع على مستندات 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. يمكنك ضبطها على قيمة قصوى تبلغ 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.

عرض قائمة بالخوادم الوكيلة المرتبطة بمضيف ظاهري ومسار أساسي

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

  • host alias = apis.acme.com
  • port = 443
  • تم تفعيل TLS

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

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

المكان:

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

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

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

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

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

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