استخدام واجهة برمجة التطبيقات API Monitoring Management

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

استخدِم واجهة برمجة التطبيقات الإدارية الخاصة بخدمة "مراقبة واجهات برمجة التطبيقات" لتنفيذ المهام التالية.

المهمة مزيد من المعلومات
إدارة التنبيهات في خدمة "مراقبة واجهة برمجة التطبيقات"
إدارة المجموعات في "مراقبة واجهة برمجة التطبيقات"
عرض سجلّات "مراقبة واجهة برمجة التطبيقات" على مستويات مختلفة
عرض مقاييس "مراقبة واجهة برمجة التطبيقات"

حصص طلبات البيانات من واجهة برمجة التطبيقات

تفرض جميع واجهات برمجة التطبيقات في خدمة "رصد واجهات برمجة التطبيقات" حصة تحدّ من عدد المرات التي يمكنك فيها استدعاء واجهة برمجة التطبيقات في الدقيقة. على سبيل المثال، تفرض واجهة برمجة التطبيقات Create collections حدًا أقصى يبلغ ست طلبات في الدقيقة.

لا تتشابه جميع واجهات برمجة التطبيقات في حدود الحصة. يمكنك الاطّلاع على المستندات المرجعية الخاصة بكل واجهة برمجة تطبيقات لمعرفة الحدّ الأقصى المسموح به.

استخدام curl

تستخدِم أمثلة واجهة برمجة التطبيقات في هذا المستند curl لتوضيح كيفية استخدام "مراقبة واجهة برمجة التطبيقات" من خلال واجهة برمجة التطبيقات. curl هي أداة مفتوحة المصدر تعمل من سطر الأوامر لنقل البيانات باستخدام بنية عنوان URL، وتتوافق مع البروتوكولات الشائعة مثل HTTP وHTTPS. للحصول على معلومات حول تنزيل curl واستخدامه، يُرجى الانتقال إلى https://curl.haxx.se/.

يلخّص الجدول التالي خيارات سطر الأوامر curl المستخدَمة في الأمثلة.

الخيار الوصف
-d '{}'

--data @filename

تحدّد هذه السمة نص الطلب الذي يتم تمريره مباشرةً أو من خلال تحديد اسم ملف.
-H

--header

تحدّد هذه السمة عنوان طلب. يجب تمرير المعلومات التالية في عنوان الطلب:
  • رمز OAuth 2.0 المميز لمصادقة المستخدم باستخدام عنوان Authorization، كما هو موضّح في الحصول على رمز مميز للوصول إلى OAuth 2.0
  • أنواع المحتوى التي يتيحها العميل باستخدام العنوان Accept
  • نوع المحتوى لنص الطلب الذي يتم إرساله عند إنشاء مورد أو تعديله (POST أو PATCH أو PUT) باستخدام العنوان Content-Type
-i يعرض المزيد من المعلومات، مثل العناوين، في الردّ.
-X تحدّد هذه السمة نوع الطلب (GET وPOST وما إلى ذلك).

الحصول على رمز دخول OAuth 2.0

تتيح Apigee Edge استخدام بروتوكول OAuth 2.0 لمصادقة المستخدمين. باستخدام OAuth 2.0، يمكنك استبدال بيانات اعتماد Apigee Edge برمز مميز للوصول ورمز مميز لإعادة التحميل يمكنك استخدامهما بعد ذلك لإجراء طلبات آمنة إلى Apigee Edge API. بعد الحصول على رمز مميّز، لن تحتاج إلى تبديل بيانات الاعتماد مرة أخرى إلى أن تنتهي صلاحية الرمز. يتيح لك الرمز المميز لإعادة التحميل إبقاء "جلستك" مع الخادم نشطة لفترة أطول بدون تقديم بيانات الاعتماد. لمزيد من المعلومات عن رموز الدخول، يُرجى الاطّلاع على استخدام OAuth2 للوصول إلى Management API.

باستخدام بيانات اعتماد Apigee Edge، يمكنك الحصول على رموز مميزة لإعادة التحميل والوصول إلى OAuth 2.0 للوصول إلى موارد Apigee Edge باستخدام أداة get_token من Apigee.

للحصول على رمز دخول OAuth 2.0 المميز، اتّبِع الخطوات التالية:

  1. ثبِّت الأداة المساعدة get_token. للحصول على معلومات حول كيفية تثبيت الأداة المساعدة get_token، اطّلِع على استخدام get_token.

  2. نفِّذ get_token للحصول على رمز دخول OAuth 2.0.

    في المرة الأولى التي تُدخل فيها الأمر أو إذا انتهت صلاحية الرمز المميز لإعادة التحميل، سيطلب منك get_token إدخال اسم المستخدم وكلمة المرور ورمز المصادقة الثنائية المكوّن من ستة أرقام. أدخِل كل قيمة عندما يُطلب منك ذلك. إذا لم تكن ميزة المصادقة الثنائية مفعّلة، ما عليك سوى الضغط على Enter عند ظهور الطلب.

  3. انسخ رمز OAuth 2.0 المميز وخزِّنه في متغيّر، مثل ACCESS_TOKEN: 

    export ACCESS_TOKEN=eyJhbGciOiJSUzI1NiJ9.eyJqdGkiOiI2NmQ4MTRiMC01YzZkLTQyZWUtYjlmYi05ZGVhODk5MGRiODIiLCJzdWIiOiJlZjc3YmRhMS05ZWIxLTQyZDgtODg5MC0zODQ3ODg0MzM1OWIiLCJzY29wZSI6WyJzY2ltLmVtYWlscy5yZWFkIiwicGFzc3dvcmQud3JpdGUiLCJhcHByb3ZhbHMubWUiLCJzY2ltLm1lIiwic2NpbS5pZHMucmVhZCIsIm9wZW5pZCIsIm9hdXRoLmFwcHJvdmFscyJdLCJjbGllbnRfaWQiOiJlZGdlY2xpIiwiY2lkIjoiZWRnZWNsaSIsImF6cCI6ImVkZ2VjbGkiLCJncmFudF90eXBlIjoicGFzc3dvcmQiLCJ1c2VyX2lkIjoiZWY3N2JkYTEtOWViMS00MmQ4LTg4OTAtMzg0Nzg4NDMzNTliIiwib3JpZ2luIjoidXNlcmdyaWQiLCJ1c2VyX25hbWUiOiJsbHluY2hAYXBpZ2VlLmNvbSIsImVtYWlsIjoibGx5bmNoQGFwaWdlZS5jb20iLCJyZXZfc2lnIjoiZTViZDc3NjIiLCJpYXQiOjE0NzA3NTMyMDksImV4cCI6MTQ3MDc5NjQwOSwiaXNzIjoiaHR0cHM6Ly9sb2dpbi5lMmUuYXBpZ2VlLm5ldC9vYXV0aC90b2tlbiIsInppZCI6InVhYSIsImF1ZCI6WyJzY2ltIiwicGFzc3dvcmQiLCJvcGVuaWQiLCJlZGdlY2xpIiwiYXBwcm92YWxzIiwic2NpbS5lbWFpbHMiLCJzY2ltLmlkcyIsIm9hdXRoIl19.FF3f1i9eHbBqYjnvBmt9nTtTcyNQBQRDDq2tQ3aRUAzUesLAet7qfBB9QVCvE-zVBn4BiPgRU-iturxPxRMAQ2a34-8oLvgff3x-aALBWkSwbc8PJdWTiPP9VYykoFSJtu9UIN5x0FQEQN_hyurO8D2SrS3uQKNwIyjoJPy4Bps7nb3WqJyKRfXAzf8UptdN7XE0TVqTyBcZGT3OQ2Was0VPfe_dr-wIrywvjNf6FczjdktB1lpKJ2oRXx1n8PuK5FhOQ4wE9VeSsNsMHVcGvJ5W6Tvi61fo2h1w1d4AKvGdERzuVf_XWN00mtcgwsUAuXV0r5H_i3vxcMuUym1XOg

عند طلب البيانات من واجهة برمجة التطبيقات API Monitoring، مرِّر رمز الدخول المميز لبروتوكول OAuth 2.0 في عنوان HTTP باستخدام العنوان Authorization. على سبيل المثال:


curl -X GET "https://apimonitoring.enterprise.apigee.com/alerts?org=myorg"
   -H "Authorization: Bearer $ACCESS_TOKEN" 
   ...