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

يتم الآن عرض مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X. المعلومات

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

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

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

راجع 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 باستخدام الإعدادات التالية:

  • الاسم المستعار للمضيف = apis.acme.com
  • المنفذ = 443
  • تم تفعيل TLS

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

https://apis.acme.com/proxy-base-path/resource-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.