إرفاق السياسات في ملفات XML وإعدادها

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

يمكنك إنشاء السياسات وتعديلها محليًا باستخدام المحرّر النصي المفضّل لديك أو المحرّر المستند إلى XML أو IDE. يستخدم هذا الموضوع نوع سياسة الحصة كمثال على كيفية إنشاء البيانات وترتيبها وإرفاقها ونشرها واختبار السياسات

تفرض معظم الخوادم الوكيلة لواجهة برمجة التطبيقات حصة. توفر الحصص التحكم في عدد مرات تشغيل تطبيق العميل مسموح باستدعاء واجهة برمجة تطبيقات خلال فترة زمنية معينة. في المثال أدناه، سياسة الحصة هي هذا يعني أن التطبيقات لا تتجاوز طلب واحد في الدقيقة. (على الرغم من أنّ هذا قد لا يكون واقعيًا، إلا أنّه يقدّم طريقة بسيطة للاطّلاع على تأثيرات السياسة).

في تهيئة الخادم الوكيل لواجهة برمجة التطبيقات، يتم تخزين ملفات السياسات كملفات XML ضمن دليل /apiproxy/policies.

على سبيل المثال، سياسة من نوع الحصة تُسمى "TrackingPolicy" كملف يسمى QuotaPolicy.xml تشتمل على المحتوى التالي:

<Quota enabled="true" continueOnError="false" name="QuotaPolicy">
    <Allow count="1"/>
    <Interval>1</Interval>
    <TimeUnit>minute</TimeUnit>
</Quota>

يمكنك إنشاء ملف نصي يدويًا أو يمكنك إنشاء السياسة من مخطط XML. تحتوي كل السياسات على بعض الإعدادات الخاصة بنوع السياسة، وبعض الإعدادات العامة التي تنطبق على جميع السياسات.

عند إرفاق السياسات في واجهة مستخدم الإدارة، ينشئ أداة إنشاء الوكيل لواجهة برمجة التطبيقات مثيل السياسة من مخطّط XML لنوع السياسة الذي اخترته. لذلك، قد تظهر لك عناصر في إعدادات السياسة، للإيضاح، لا يتم تضمينها دائمًا في المستندات.

تحدّد جميع السياسات السمات التالية:

  • enabled: يشير إلى ما إذا كانت السياسة "مفعَّلة" أو "إيقاف". يمكن تفعيل السياسات أو إيقافها أثناء التشغيل من خلال تغيير هذا الإعداد. سياسة تتضمّن enabled ولا يتم فرض ضبطها على false.
  • continueOnError: تحدِّد هذه السياسة ما إذا كان يجب أن تستمرّ العملية في معالجة في حال تعذُّر تنفيذ السياسة. عند فرض سياسات الحصص، من المرجّح أن تشير الأخطاء إلى أنّه تم تجاوز الحصة، وبالتالي يجب ضبط هذه السمة على خطأ.
  • name: الاسم الذي تحدّده لهذه السياسة هذا الاسم فريد لهذا الاسم وتُستخدَم لإرفاق السياسة بالمسار كخطوة معالجة.

في المثال أعلاه، العناصر Allow وInterval و ترتبط سياسة TimeUnit بسياسة الحصة. توفر هذه العناصر الإعدادات التي تتيحها واجهة برمجة التطبيقات يتم فرض الخدمات نيابةً عن واجهة برمجة التطبيقات. تُحدِّد أنواع السياسات الأخرى إعداداتها الخاصة، والتي يمكنك يمكنك الاطّلاع على المزيد من المعلومات حوله في مرجع السياسة.