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

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

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

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

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

على سبيل المثال، يمكن إنشاء سياسة من النوع "حصة" تُسمى "QuotaPolicy" كملف باسم 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 مخصّصة لسياسة الحصة. توفر هذه العناصر الإعدادات التي تفرضها خدمات واجهة برمجة التطبيقات نيابة عن واجهة برمجة التطبيقات. وتحدّد أنواع السياسات الأخرى إعداداتها الخاصة، والتي يمكنك الاطّلاع على مزيد من المعلومات عنها في مرجع السياسات.