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

شما در حال مشاهده اسناد 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_- N/A بله
revision شماره بازبینی پیکربندی بسته جریان مشترک. شما نیازی به تنظیم صریح شماره ویرایش ندارید، زیرا Apigee Edge به طور خودکار ویرایش فعلی جریان مشترک را ردیابی می کند. N/A خیر

عناصر پیکربندی پایه

نام توضیحات پیش فرض مورد نیاز؟
SharedFlowBundle
ConfigurationVersion نسخه ای از طرح پیکربندی دسته جریان مشترک که این جریان مشترک با آن مطابقت دارد. تنها مقدار پشتیبانی شده در حال حاضر majorVersion 4 و minorVersion 0 است. این تنظیم ممکن است در آینده برای فعال کردن تکامل قالب دسته جریان مشترک استفاده شود. 4.0 خیر
CreatedAt و CreatedBy تاریخ/زمان (بر حسب زمان) که بسته جریان مشترک ایجاد شده است، همراه با ایمیل کاربری که آن را ایجاد کرده است.
Description شرح متنی جریان مشترک. در صورت ارائه، توضیحات در رابط کاربری مدیریت Edge نمایش داده می شود. N/A خیر
DisplayName یک نام کاربرپسند که ممکن است با ویژگی name پیکربندی جریان مشترک متفاوت باشد. N/A خیر
LastModifiedAt و LastModifiedBy تاریخ/زمان (بر حسب زمان) آخرین تغییر بسته جریان مشترک، همراه با ایمیل کاربری که آن را تغییر داده است.
Policies فهرستی از خط‌مشی‌ها در فهرست /policies این جریان مشترک. شما معمولاً تنها زمانی این عنصر را خواهید دید که جریان اشتراکی با استفاده از رابط کاربری مدیریت Edge ایجاد شده باشد. این صرفاً یک تنظیم آشکار است که برای ارائه دید به محتوای جریان مشترک طراحی شده است. N/A خیر
Resources فهرستی از منابع (جاوا اسکریپت، پایتون، جاوا، XSLT) در دایرکتوری /resources این جریان مشترک. شما معمولاً تنها زمانی این عنصر را خواهید دید که جریان اشتراکی با استفاده از رابط کاربری مدیریت Edge ایجاد شده باشد. این به سادگی یک تنظیم "مظهر" است که برای ارائه دید به محتویات جریان مشترک طراحی شده است. N/A خیر
SharedFlows جریان مشترکی را که این بسته حاوی آن است مشخص می کند.

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

N/A بله

جریان های مشترک

/sharedflowbundle/sharedflows/default.xml

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

پیکربندی SharedFlow زیر سه خط‌مشی را مشخص می‌کند که باید در یک دنباله از بالا به پایین (از چپ به راست در کنسول مدیریت) اجرا شوند، ابتدا خط‌مشی Spike Arrest و در آخر خط‌مشی Flow Callout .

<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_- N/A بله
revision شماره بازبینی پیکربندی جریان مشترک. شما نیازی به تنظیم صریح شماره ویرایش ندارید، زیرا Apigee Edge به طور خودکار ویرایش فعلی جریان مشترک را ردیابی می کند. N/A خیر

عناصر پیکربندی جریان مشترک

نام توضیحات پیش فرض مورد نیاز؟
SharedFlow توالی سیاست ها را در جریان مشترک تعریف می کند. N/A بله
Step یک مرحله را تعریف می کند -- مرحله ای در دنباله جریان. N/A بله
Name نام مورد اشاره شده توسط مرحله را مشخص می کند. مقدار این عنصر باید با شناسه منحصر به فرد مورد، مانند مقدار ویژگی نام خط مشی، یکسان باشد. N/A بله

سیاست ها

/sharedflowbundle/policies

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

منابع

/sharedflowbundle/resources

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

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

سوالات خود را به انجمن توسعه دهندگان Apigee ارسال کنید.