مرجع پیکربندی بسته جاری‌سازی مشترک

درحال مشاهده اسناد Apigee Edge هستید.
به اسناد Apigee X بروید.
اطلاعات

جریان مشترک عملکردی قابل استفاده مجدد شبیه به پراکسی API است. اگر با پراکسی‌های API آشنایی داشته باشید، بسیاری از محتوای این مرجع برایتان آشنا خواهد بود.

اگر درحال یادگیری نحوه ساختن جریان مشترک هستید، با موضوع جریان‌های مشترک قابل‌استفاده مجدد شروع کنید.

ساختار دسته‌ای جریان مشترک

دسته جریان مشترک از پیکربندی زیر تشکیل شده است:

پیکربندی پایه تنظیمات پیکربندی اصلی. پیکربندی پایه را ببینید.
خط‌مشی‌ها فایل‌های پیکربندی با قالب XML که با طرحواره‌های خط‌مشی Apigee Edge مطابقت دارند. به خط‌مشی‌ها مراجعه کنید.
منابع اسکریپت‌ها، فایل‌های JAR، و فایل‌های XSLT که توسط خط‌مشی‌ها برای اجرای منطق سفارشی ارجاع داده می‌شوند. منابع را ببینید.
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 و minorVersion 0 است. این تنظیم ممکن است در آینده برای فعال کردن تکامل قالب بسته جاری‌سازی هم‌رسانی‌شده استفاده شود. ۴٫۰ نه
‫CreatedAt و CreatedBy تاریخ/زمان (به‌صورت زمان یونیکس) ایجاد بسته جاری‌سازی هم‌رسانی‌شده، به‌همراه ایمیل کاربری که آن را ایجاد کرده است.
Description توضیح نوشتاری جاری‌سازی هم‌رسانی‌شده. درصورت ارائه، شرح در واسط کاربر مدیریت Edge نمایش داده خواهد شد. موجود نیست نه
DisplayName نامی کاربرپسند که ممکن است با مشخصه name پیکربندی جریان مشترک متفاوت باشد. موجود نیست نه
‫LastModifiedAt و LastModifiedBy تاریخ/زمان (به‌صورت زمان عصر) آخرین تغییر در بسته جاری‌سازی هم‌رسانی‌شده، به‌همراه ایمیل کاربری که آن را تغییر داده است.
Policies فهرستی از خط‌مشی‌ها در دایرکتوری /policies این جریان مشترک. شما معمولاً این عنصر را فقط زمانی می‌بینید که جریان مشترک بااستفاده از واسط کاربر مدیریت Edge ایجاد شده باشد. این صرفاً یک تنظیم «مانیفست» است که برای ارائه دید به محتوای جاری‌سازی هم‌رسانی‌شده طراحی شده است. موجود نیست نه
Resources فهرست منابع (JavaScript،‏ Python،‏ Java،‏ XSLT) در /resources دایرکتوری این جریان مشترک. معمولاً این عنصر را فقط زمانی می‌بینید که جاری‌سازی هم‌رسانی‌شده بااستفاده از واسط کاربر مدیریت Edge ایجاد شده باشد. این صرفاً یک تنظیم «مانیفست» است که برای ارائه رؤیت‌پذیری در محتوای جاری‌سازی هم‌رسانی‌شده طراحی شده است. موجود نیست نه
SharedFlows جریان مشترکی را که این دسته حاوی آن است مشخص می‌کند.

توجه داشته باشید که درحال‌حاضر، این عنصر فقط از یک فرزند <SharedFlow> پشتیبانی می‌کند. فقط یک جریان مشترک می‌تواند به بسته جریان مشترک اضافه شود.

موجود نیست بله

جریان‌های هم‌رسانی‌شده

/sharedflowbundle/sharedflows/default.xml

پیکربندی SharedFlow ترتیب اجرای عناصر جاری‌سازی را تعریف می‌کند. عنصر <SharedFlow> و عناصر فرزند <Step> هرکدام بخشی از توالی را مشخص می‌کنند، مثل فراخوانی خط‌مشی.

پیکربندی 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

همانند پراکسی API، در بسته جریان مشترک، دایرکتوری /policies حاوی پیکربندی XML برای همه خط‌مشی‌هایی است که برای پیوستن به جریان مشترک در بسته دردسترس هستند. خط‌مشی‌ها زیرمجموعه‌ای از عناصر را هم‌رسانی می‌کنند، اگرچه این زیرمجموعه با عناصری که مختص خط‌مشی هستند تکمیل می‌شود. برای اطلاعات بیشتر درباره نحوه پیکربندی خط‌مشی، موضوع خط‌مشی موردنظرتان را ببینید. همچنین می‌توانید از نمای کلی مرجع خط‌مشی به این موارد دسترسی پیدا کنید.

منابع

/sharedflowbundle/resources

منابع عبارت‌اند از دستورگان‌ها، کد، و تبدیل‌های XSL که می‌توانند بااستفاده از خط‌مشی‌ها به جاری‌سازی‌های مشترک پیوست شوند. این‌ها در بخش «دستورگان» ویرایشگر جاری مشترک در واسط کاربر مدیریت نشان داده می‌شود.

برای اطلاع از انواع منبع پشتیبانی‌شده، فایل‌های منبع را ببینید.

سؤالات را در تالار گفتمان توسعه‌دهندگان Apigee پست کنید.