استخدام وحدة وصول واجهة برمجة التطبيقات

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

يتيح لك الوحدة apigee-access الوصول إلى متغيرات تدفق خادم وكيل لواجهة برمجة التطبيقات وذاكرات التخزين المؤقت من داخل الرمز البرمجي لتطبيق Node.js. يتم تضمين الوحدة في منصة Apigee Edge، ولست بحاجة إلى تثبيتها كما تفعل مع وحدات Node.js الأخرى.

الحصول على apigee-access

تم دمج الوحدة apigee-access في منصة Apigee Edge. عند نشر رمز Node.js على Edge، ستتوفّر لك هذه الوحدة. ما عليك سوى تضمينها في أي رمز Node.js تنشره. على سبيل المثال:

var access=require('apigee-access');

الوصول إلى متغيّرات سير العمل

عند نشر تطبيق Node.js على Edge، يمكنك الوصول إلى أي من متغيرات التدفق المتوافقة "الجاهزة للاستخدام" ومتغيرات التدفق التي تم إنشاؤها بواسطة السياسات وأي متغيرات تدفق تنشئها بنفسك من داخل رمز Node.js. يتم إنشاء متغيرات التدفق وتكون متاحة ضمن سياق خادم وكيل لواجهة برمجة التطبيقات يعمل على Edge. للحصول على معلومات مفصّلة، راجِع الوصول إلى متغيرات التدفق في Node.js.

الوصول إلى ذاكرة التخزين المؤقت

تتيح لك الوحدة apigee-access الوصول إلى ذاكرة التخزين المؤقت الموزّعة في Apigee Edge من رمز Node.js. للحصول على معلومات مفصّلة، يُرجى الاطّلاع على الوصول إلى ذاكرة التخزين المؤقت في Node.js.

استخدام خدمة الحصة

يتيح لك الوحدة النمطية apigee-access الوصول إلى خدمة الحصص في Apigee Edge من رمز Node.js. للحصول على معلومات مفصّلة، يُرجى الاطّلاع على الوصول إلى خدمة الحصة في Node.js.

الوصول إلى خرائط المفاتيح والقيم

يتيح لك الوحدة apigee-access الوصول إلى خرائط القيم الرئيسية (KVM) في Apigee Edge من رمز Node.js. للحصول على معلومات مفصّلة، يُرجى الاطّلاع على الوصول إلى خرائط القيم الرئيسية في Node.js.

التشغيل في الوضع المحلي مقابل وضع النشر

لإتاحة التطوير والاختبار على الجهاز، تعمل وحدة apigee-access في الوضع المحلي بدون أي تبعيات على Apigee Edge، ولكن عند استخدام الوحدة مع خادم وكيل لواجهة برمجة التطبيقات تم نشره على Edge، يتم استبدال الوظيفة "المحلية" بوظيفة Edge الأصلية. على سبيل المثال، يمكن الوصول إلى المجموعة الكاملة من متغيرات التدفق في الوضع الذي تم فيه النشر، بينما لا يتوفّر سوى مجموعة فرعية صغيرة عند تشغيل تطبيق Node.js محليًا. للحصول على قائمة بمتغيرات الوضع المحلي، يُرجى الاطّلاع على التشغيل في الوضع المحلي.

تحديد الوضع الذي يتم تشغيل الوحدة النمطية فيه

لتحديد الوضع الذي يتم تشغيل apigee-access فيه، اتّبِع الخطوات التالية:

var access = require('apigee-access')
console.log('The deployment mode is ' + access.getMode());

تخبرك القيمة المعروضة من getMode() ما إذا كان تطبيق Node.js قد تم نشره على Apigee Edge أو ما إذا كان يتم تشغيله في وضع مستقل. تُنتج الطريقة إحدى نتيجتَي السلسلة التاليتَين:

  • ‫apigee - يتم تشغيل تطبيق Node.js على Apigee Edge، ويتوافق مع جميع الوظائف.
  • standalone - يتم تشغيل تطبيق Node.js خارج بيئة Apigee Edge، ويتم تفعيل الوظيفة التلقائية الموضّحة في أعلى المستند.

التشغيل في الوضع الذي تم نشره

عند نشرها على Edge، تكون المتغيّرات التي تحدّدها السياسات مرئية apigee-access، وتكون المتغيّرات التي تضيفها أو تعدّلها طرق هذه الوحدة مرئية للسياسات اللاحقة في مسار الخادم الوكيل.

يمكنك العثور على رابط المتغيرات المتوافقة في مرجع المتغيرات. تكون هذه المتغيرات، وأي متغيرات أخرى تنشئها بأسماء خاصة بك، مرئية لـ apigee-access. يُرجى العِلم أنّ بعض المتغيّرات تكون للقراءة فقط. ويمكن العثور عليها في مرجع المتغيّرات.

التشغيل في الوضع المحلي

في "الوضع المحلي"، يتم تشغيل رمز Node.js خارج سياق Apigee Edge. في هذا الوضع، لا يمكن الوصول إلى معظم متغيرات التدفق المحدّدة مسبقًا ضمن رمز Node.js. يعرض هذا الجدول مجموعة فرعية صغيرة من متغيّرات التدفق المتاحة. تتوفّر هذه المتغيّرات هنا من أجل إتاحة تطوير تطبيقات Node.js واختبارها على الجهاز المحلي في Apigee Edge.

المتغيّر للقراءة فقط النوع ملاحظات
client.received.start.time نعم سلسلة الوقت الذي تم فيه استلام الطلب
client.received.end.time نعم سلسلة الوقت الذي تم فيه استلام الطلب
client.received.start.timestamp نعم عدد صحيح الوقت الذي تم فيه استلام الطلب
client.received.end.timestamp نعم عدد صحيح الوقت الذي تم فيه استلام الطلب

مرة أخرى، على منصة Apigee Edge، تتوفّر مجموعة أكبر بكثير من المتغيرات المحدّدة مسبقًا. راجِع مرجع المتغيرات في Apigee Edge للاطّلاع على القائمة الكاملة.