مرجع ضبط حِزمة التدفق المشتركة

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

التدفق المشترك هو وظيفة قابلة لإعادة الاستخدام تشبه الخادم الوكيل لواجهة برمجة التطبيقات. إذا كنت معتادًا على استخدام الخوادم الوكيلة لواجهة برمجة التطبيقات، يمكنك الاطّلاع على معظم محتوى هذا المرجع.

إذا كنت تتعلم كيفية إنشاء تدفق مشترك، فابدأ بالموضوع تدفقات مشتركة قابلة لإعادة الاستخدام.

بنية حزمة التدفق المشترك

تتألف حزمة التدفق المشترك من التهيئة التالية:

الإعداد الأساسي إعدادات الضبط الأساسية. يُرجى الاطِّلاع على الإعداد الأساسي.
السياسات ملفات الإعداد بتنسيق XML والتي تتوافق مع مخططات سياسة Apigee Edge. يُرجى الاطّلاع على السياسات.
المراجع النصوص البرمجية وملفات JAR وملفات WebRTC المشار إليها بواسطة السياسات لتنفيذ منطق مخصص. اطّلِع على المراجع.
SharedFlows التدفقات المشتركة المضمّنة في هذه الحزمة. يُرجى الاطّلاع على التدفقات المشتركة.

يتم تحديد المكوّنات الواردة في الجدول أعلاه من خلال ملفات الإعداد في بنية الدليل التالية:

ملفات الإعداد وبنية الدليل لحزمة تدفق مشتركة

يوضّح هذا القسم ملفات الإعداد وبنية الدليل لحزمة تدفق مشتركة.

تكوين القاعدة

يقع ملف الإعداد الأساسي في الدليل الجذري للحزمة. واسمها هو اسم الحِزمة.

/sharedflowbundle/traffic-management-shared.xml

تحدد الإعدادات الأساسية محتوى حزمة التدفق المشترك، بالإضافة إلى معلومات حول تتبع سجل النُسخ السابقة للحزمة.

<SharedFlowBundle revision="2" name="traffic-management-shared">
    <ConfigurationVersion majorVersion="4" minorVersion="0"/>
    <CreatedAt>1478637529218</CreatedAt>
    <CreatedBy>gladys@example.com</CreatedBy>
    <Description>Shared flow to moderate API traffic</Description>
    <DisplayName>traffic-management-shared</DisplayName>
    <LastModifiedAt>1481573374023</LastModifiedAt>
    <LastModifiedBy>gladys@example.com</LastModifiedBy>
    <Policies>
        <Policy>Auth-Flow-Callout</Policy>
        <Policy>Extract-Token</Policy>
        <Policy>Spike-Arrest</Policy>
    </Policies>
    <Resources>
        <Resource>jsc://extract-token.js</Resource>
    </Resources>
    <SharedFlows>
        <SharedFlow>default</SharedFlow>
    </SharedFlows>
</SharedFlowBundle>

سمات التكوين الأساسية

الاسم الوصف تلقائي مطلوب؟
SharedFlowBundle
name اسم حزمة التدفق المشترك التي يجب أن تكون فريدة داخل مؤسسة. وتقتصر الأحرف التي يُسمح لك باستخدامها في الاسم على ما يلي: A-Za-z0-9_- لا ينطبق نعم
revision رقم النسخة السابقة لإعدادات حزمة التدفق المشتركة. ولا تحتاج إلى ضبط رقم النسخة السابقة بشكل صريح، لأنّ Apigee Edge يتتبّع تلقائيًا النسخة الحالية من التدفق المشترك. لا ينطبق لا

عناصر الإعداد الأساسي

الاسم الوصف تلقائي مطلوب؟
SharedFlowBundle
ConfigurationVersion تمثّل هذه السمة إصدار مخطط إعداد حزمة التدفق المشتركة الذي يتوافق معه هذا التدفق المشترك. القيمة الوحيدة المتاحة حاليًا هي majorVersion 4 وMinVersion 0. يمكن استخدام هذا الإعداد في المستقبل لإتاحة إمكانية تطوير تنسيق حزمة التدفق المشترك. 4 لا
CreatedAt وCreatedBy التاريخ/الوقت (في وقت الحقبة) الذي تم فيه إنشاء حزمة التدفق المشتركة، بالإضافة إلى عنوان البريد الإلكتروني للمستخدم الذي أنشأها.
Description وصف نصي للتدفق المشترك. في حال توفير الوصف، سيتم عرضه في واجهة مستخدم إدارة Edge. لا ينطبق لا
DisplayName اسم سهل الاستخدام قد يختلف عن السمة name الخاصة بإعدادات التدفق المشترك. لا ينطبق لا
LastModifiedAt وLastModifiedBy التاريخ/الوقت (في وقت الحقبة) الذي تم فيه إجراء آخر تعديل على حزمة التدفق المشتركة، بالإضافة إلى عنوان البريد الإلكتروني للمستخدم الذي عدّلها.
Policies قائمة بالسياسات في دليل /policies لهذا التدفق المشترك. لن يظهر لك عادةً هذا العنصر عادةً إلا عند إنشاء التدفق المشترك باستخدام واجهة مستخدم إدارة Edge. إنّ هذا الإعداد هو ببساطة إعداد "بيان"، تم تصميمه لتوفير إمكانية الاطّلاع على محتوى التدفق المشترك. لا ينطبق لا
Resources قائمة بالموارد (JavaScript وPython وJava وTalkBack) في دليل /resources لهذا التدفق المشترك. لن يظهر لك هذا العنصر عادةً إلا عند إنشاء التدفق المشترك باستخدام واجهة مستخدم إدارة Edge. إنّه إعداد "بيان" تم تصميمه لتوفير إمكانية رؤية محتوى التدفق المشترك. لا ينطبق لا
SharedFlows تُحدِّد التدفق المشترك الذي تحتوي عليه هذه الحزمة.

تجدر الإشارة إلى أنّ هذا العنصر يتيح حاليًا استخدام عنصر <SharedFlow> فرعي واحد فقط. يمكن إضافة مسار مشترك واحد فقط إلى حزمة تدفق مشتركة.

لا ينطبق نعم

المسارات المشتركة

/sharedflowbundle/sharedflows/default.xml

تُحدِّد إعدادات SharedFlow التسلسل الذي يجب تنفيذ عناصر التدفق فيه. يحدّد كل عنصر من عناصر <Step> التابعة لعنصر <SharedFlow> جزءًا من التسلسل، مثل استدعاء سياسة.

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

<SharedFlow name="default">
    <Step>
        <Name>Spike-Arrest</Name>
    </Step>
    <Step>
        <Name>Extract-Token</Name>
    </Step>
    <Step>
        <Name>Auth-Flow-Callout</Name>
    </Step>
</SharedFlow>

سمات ضبط التدفق المشترك

الاسم الوصف تلقائي مطلوب؟
SharedFlow
name اسم التدفق المشترك، والذي يجب أن يكون فريدًا داخل المؤسسة. وتقتصر الأحرف التي يُسمح لك باستخدامها في الاسم على ما يلي: A-Za-z0-9_- لا ينطبق نعم
revision رقم النسخة السابقة لإعدادات التدفق المشترك. ولا تحتاج إلى ضبط رقم النسخة السابقة بشكل صريح، لأنّ Apigee Edge يتتبّع تلقائيًا النسخة الحالية من التدفق المشترك. لا ينطبق لا

عناصر ضبط التدفق المشترك

الاسم الوصف تلقائي مطلوب؟
SharedFlow تحدد تسلسل السياسات في التدفق المشترك. لا ينطبق نعم
Step تحدد الخطوة -- مرحلة في تسلسل التدفق. لا ينطبق نعم
Name تُحدِّد اسم العنصر المُشار إليه في الخطوة. يجب أن تكون قيمة هذا العنصر مطابقة للمعرّف الفريد للعنصر، مثل قيمة سمة اسم السياسة. لا ينطبق نعم

السياسات

/sharedflowbundle/policies

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

المراجِع

/sharedflowbundle/resources

والموارد عبارة عن نصوص برمجية ورموز وتحويلات XSL يمكن إرفاقها بالتدفقات المشتركة باستخدام السياسات. يظهر هذان العنوانان في قسم "النصوص البرمجية" ضمن مُحرِّر التدفق المشترك في واجهة مستخدم الإدارة.

راجِع ملفات الموارد للتعرّف على أنواع الموارد المتوافقة.

يمكنك طرح أسئلة على منتدى مطوّري Apigee.