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

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

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

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

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

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

پیکربندی پایه تنظیمات پیکربندی اولیه. به پیکربندی پایه مراجعه کنید.
سیاست‌ها فایل‌های پیکربندی با فرمت XML که با طرحواره‌های سیاست Apigee Edge مطابقت دارند. به بخش سیاست‌ها مراجعه کنید.
منابع اسکریپت‌ها، فایل‌های JAR و فایل‌های XSLT که توسط سیاست‌ها برای اجرای منطق سفارشی ارجاع داده می‌شوند. به منابع مراجعه کنید.
جریان‌های اشتراکی جریان‌های مشترک موجود در این بسته. به جریان‌های مشترک مراجعه کنید.

اجزای جدول بالا توسط فایل‌های پیکربندی در ساختار دایرکتوری زیر تعریف می‌شوند:

فایل‌های پیکربندی و ساختار دایرکتوری یک بسته جریان مشترک

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

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

فایل پیکربندی پایه در دایرکتوری ریشه بسته نرم‌افزاری قرار دارد و نام آن، نام بسته نرم‌افزاری است.

/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 تاریخ/زمان (به زمان epoch) که بسته جریان مشترک ایجاد شده است، به همراه ایمیل کاربری که آن را ایجاد کرده است.
Description شرح متنی از جریان مشترک. در صورت ارائه، شرح در رابط کاربری مدیریت Edge نمایش داده می‌شود. ناموجود خیر
DisplayName یک نام کاربرپسند که ممکن است با ویژگی name پیکربندی جریان مشترک متفاوت باشد. ناموجود خیر
LastModifiedAt و LastModifiedBy تاریخ/زمان (به زمان epoch) که بسته جریان مشترک آخرین بار تغییر داده شده است، به همراه ایمیل کاربری که آن را تغییر داده است.
Policies فهرستی از خط‌مشی‌ها در دایرکتوری /policies این جریان مشترک. معمولاً این عنصر را فقط زمانی مشاهده خواهید کرد که جریان مشترک با استفاده از رابط کاربری مدیریت Edge ایجاد شده باشد. این صرفاً یک تنظیم «مانیفست» است که برای ارائه قابلیت مشاهده محتوای جریان مشترک طراحی شده است. ناموجود خیر
Resources فهرستی از منابع (جاوااسکریپت، پایتون، جاوا، XSLT) در دایرکتوری /resources این جریان مشترک. معمولاً این عنصر را فقط زمانی مشاهده خواهید کرد که جریان مشترک با استفاده از رابط کاربری مدیریت Edge ایجاد شده باشد. این صرفاً یک تنظیم «مانیفست» است که برای ارائه قابلیت مشاهده محتوای جریان مشترک طراحی شده است. ناموجود خیر
SharedFlows جریان مشترکی را که این بسته شامل می‌شود، مشخص می‌کند.

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

ناموجود بله

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

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

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

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

سیاست‌ها

/sharedflowbundle/policies

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

منابع

/sharedflowbundle/resources

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

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

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

،

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

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

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

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

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

پیکربندی پایه تنظیمات پیکربندی اولیه. به پیکربندی پایه مراجعه کنید.
سیاست‌ها فایل‌های پیکربندی با فرمت XML که با طرحواره‌های سیاست Apigee Edge مطابقت دارند. به بخش سیاست‌ها مراجعه کنید.
منابع اسکریپت‌ها، فایل‌های JAR و فایل‌های XSLT که توسط سیاست‌ها برای اجرای منطق سفارشی ارجاع داده می‌شوند. به منابع مراجعه کنید.
جریان‌های اشتراکی جریان‌های مشترک موجود در این بسته. به جریان‌های مشترک مراجعه کنید.

اجزای جدول بالا توسط فایل‌های پیکربندی در ساختار دایرکتوری زیر تعریف می‌شوند:

فایل‌های پیکربندی و ساختار دایرکتوری یک بسته جریان مشترک

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

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

فایل پیکربندی پایه در دایرکتوری ریشه بسته نرم‌افزاری قرار دارد و نام آن، نام بسته نرم‌افزاری است.

/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 تاریخ/زمان (به زمان epoch) که بسته جریان مشترک ایجاد شده است، به همراه ایمیل کاربری که آن را ایجاد کرده است.
Description شرح متنی از جریان مشترک. در صورت ارائه، شرح در رابط کاربری مدیریت Edge نمایش داده می‌شود. ناموجود خیر
DisplayName یک نام کاربرپسند که ممکن است با ویژگی name پیکربندی جریان مشترک متفاوت باشد. ناموجود خیر
LastModifiedAt و LastModifiedBy تاریخ/زمان (به زمان epoch) که بسته جریان مشترک آخرین بار تغییر داده شده است، به همراه ایمیل کاربری که آن را تغییر داده است.
Policies فهرستی از خط‌مشی‌ها در دایرکتوری /policies این جریان مشترک. معمولاً این عنصر را فقط زمانی مشاهده خواهید کرد که جریان مشترک با استفاده از رابط کاربری مدیریت Edge ایجاد شده باشد. این صرفاً یک تنظیم «مانیفست» است که برای ارائه قابلیت مشاهده محتوای جریان مشترک طراحی شده است. ناموجود خیر
Resources فهرستی از منابع (جاوااسکریپت، پایتون، جاوا، XSLT) در دایرکتوری /resources این جریان مشترک. معمولاً این عنصر را فقط زمانی مشاهده خواهید کرد که جریان مشترک با استفاده از رابط کاربری مدیریت Edge ایجاد شده باشد. این صرفاً یک تنظیم «مانیفست» است که برای ارائه قابلیت مشاهده محتوای جریان مشترک طراحی شده است. ناموجود خیر
SharedFlows جریان مشترکی را که این بسته شامل می‌شود، مشخص می‌کند.

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

ناموجود بله

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

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

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

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

سیاست‌ها

/sharedflowbundle/policies

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

منابع

/sharedflowbundle/resources

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

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

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