Tham chiếu cấu hình gói luồng dùng chung

Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về Apigee X. thông tin

Luồng dùng chung là chức năng có thể sử dụng lại tương tự như proxy API. Hầu hết nội dung của tài liệu tham khảo này sẽ quen thuộc nếu bạn đã quen thuộc với proxy API.

Nếu bạn đang tìm hiểu cách xây dựng luồng dùng chung, hãy bắt đầu với chủ đề Luồng dùng chung có thể tái sử dụng.

Cấu trúc gói luồng dùng chung

Gói luồng dùng chung bao gồm cấu hình sau:

Cấu hình cơ sở Chế độ cài đặt cấu hình chính. Xem phần Cấu hình cơ sở.
Chính sách Các tệp cấu hình ở định dạng XML tuân thủ giản đồ chính sách Apigee Edge. Hãy xem Chính sách.
Tài nguyên Tập lệnh, tệp JAR và tệp XML được tham chiếu bởi các chính sách để thực thi logic tuỳ chỉnh. Hãy xem phần Tài nguyên.
SharedFlows Các luồng được chia sẻ có trong gói này. Xem Quy trình dùng chung.

Các thành phần trong bảng trên được xác định bởi các tệp cấu hình trong cấu trúc thư mục sau:

Tệp cấu hình và cấu trúc thư mục của gói luồng dùng chung

Phần này giải thích các tệp cấu hình và cấu trúc thư mục của gói luồng dùng chung.

Cấu hình cơ sở

Tệp cấu hình cơ sở nằm ở thư mục gốc của gói. Tên của gói này là tên của gói.

/sharedflowbundle/traffic-management-shared.xml

Cấu hình cơ sở xác định nội dung của gói luồng dùng chung, cùng với thông tin để theo dõi nhật ký sửa đổi của gói.

<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>

Thuộc tính cấu hình cơ sở

Tên Nội dung mô tả Mặc định Bắt buộc?
SharedFlowBundle
name Tên của gói luồng dùng chung phải là duy nhất trong một tổ chức. Bạn chỉ được phép sử dụng các ký tự sau đây trong tên: A-Za-z0-9_- Không áp dụng Có
revision Số bản sửa đổi của cấu hình gói luồng dùng chung. Bạn không cần phải đặt số bản sửa đổi một cách rõ ràng, vì Apigee Edge sẽ tự động theo dõi bản sửa đổi hiện tại của quy trình dùng chung. Không áp dụng Không

Phần tử cấu hình cơ sở

Tên Nội dung mô tả Mặc định Bắt buộc?
SharedFlowBundle
ConfigurationVersion Phiên bản của giản đồ cấu hình gói luồng dùng chung mà luồng dùng chung này tuân theo. Giá trị duy nhất được hỗ trợ hiện tại là lớnVersion 4 và nhỏVersion 0. Chế độ cài đặt này có thể được sử dụng trong tương lai để cho phép phát triển định dạng gói luồng dùng chung. 4 Không
CreatedAt và CreatedBy Ngày/giờ (theo thời gian bắt đầu của hệ thống) mà gói luồng dùng chung được tạo, cùng với email của người dùng đã tạo gói luồng đó.
Description Thông tin mô tả bằng văn bản về quy trình chung. Nếu được cung cấp, nội dung mô tả sẽ hiển thị trong giao diện người dùng Quản lý Edge. Không áp dụng Không
DisplayName Tên thân thiện với người dùng có thể khác với thuộc tính name của cấu hình luồng dùng chung. Không áp dụng Không
LastModifiedAt và LastModifiedBy Ngày/giờ (theo thời gian bắt đầu của hệ thống) mà gói luồng được chia sẻ được sửa đổi lần gần đây nhất, cùng với email của người dùng đã sửa đổi gói.
Policies Danh sách các chính sách trong thư mục /policies của quy trình dùng chung này. Thông thường, bạn sẽ chỉ thấy phần tử này khi luồng dùng chung được tạo bằng giao diện người dùng quản lý Edge. Đây chỉ là một chế độ cài đặt "tệp kê khai", được thiết kế để cho phép bạn xem nội dung của luồng dùng chung. Không áp dụng Không
Resources Danh sách tài nguyên (JavaScript, Python, Java, GCC) trong thư mục /resources của quy trình dùng chung này. Thông thường, bạn sẽ chỉ thấy phần tử này khi quy trình chia sẻ được tạo bằng giao diện người dùng quản lý Edge. Đây chỉ là một chế độ cài đặt "tệp kê khai", được thiết kế để cho phép bạn xem nội dung của luồng dùng chung. Không áp dụng Không
SharedFlows Chỉ định luồng dùng chung có trong gói này.

Xin lưu ý rằng hiện tại, phần tử này chỉ hỗ trợ một <SharedFlow> con. Bạn chỉ có thể thêm một luồng dùng chung vào gói luồng dùng chung.

 Không áp dụng Có

Luồng được chia sẻ

/sharedflowbundle/sharedflows/default.xml

Cấu hình SharedFlow xác định trình tự mà các phần tử luồng sẽ được thực thi. Mỗi phần tử con <Step> của phần tử <SharedFlow> chỉ định một phần của trình tự, chẳng hạn như một lệnh gọi đến một chính sách.

Cấu hình SharedFlow sau đây chỉ định 3 chính sách sẽ được thực thi theo trình tự từ trên xuống dưới (từ trái sang phải trong bảng điều khiển quản lý), với chính sách Spike Arrest ở trước và chính sách Chú thích flow cuối cùng.

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

Thuộc tính cấu hình luồng dùng chung

Tên Nội dung mô tả Mặc định Bắt buộc?
SharedFlow
name Tên của luồng dùng chung phải là tên duy nhất trong một tổ chức. Bạn chỉ được phép sử dụng các ký tự sau đây trong tên: A-Za-z0-9_- Không áp dụng Có
revision Số bản sửa đổi của cấu hình luồng dùng chung. Bạn không cần phải chỉ định số bản sửa đổi một cách rõ ràng, vì Apigee sẽ tự động theo dõi bản sửa đổi hiện tại của quy trình dùng chung. Không áp dụng Không

Phần tử cấu hình của luồng dùng chung

Tên Nội dung mô tả Mặc định Bắt buộc?
SharedFlow Xác định trình tự các chính sách trong luồng dùng chung. Không áp dụng Có
Step Xác định một bước – một giai đoạn trong trình tự của luồng. Không áp dụng Có
Name Chỉ định tên của mục được tham chiếu mà bước thực hiện. Giá trị của phần tử này phải giống với giá trị nhận dạng duy nhất của mặt hàng, chẳng hạn như giá trị thuộc tính tên của chính sách. Không áp dụng Có

Chính sách

/sharedflowbundle/policies

Như trong proxy API, trong gói luồng dùng chung, thư mục /policies chứa XML cấu hình dành cho tất cả các chính sách có sẵn để đính kèm vào luồng dùng chung trong gói đó. Các chính sách có chung một nhóm nhỏ các thành phần, mặc dù nhóm nhỏ này bổ sung cho các thành phần dành riêng cho chính sách. Để biết thêm về cách thiết lập một chính sách, hãy xem chủ đề về chính sách bạn muốn. Bạn cũng có thể truy cập những chính sách này từ bài viết Tổng quan về tài liệu tham khảo chính sách.

Tài nguyên

/sharedflowbundle/resources

Tài nguyên là các tập lệnh, mã và các phép chuyển đổi NDK có thể được đính kèm vào các luồng được chia sẻ bằng chính sách. Các tập lệnh này xuất hiện trong phần Tập lệnh của trình chỉnh sửa quy trình dùng chung trong giao diện người dùng quản lý.

Xem phần Tệp tài nguyên để biết các loại tài nguyên được hỗ trợ.

Đăng câu hỏi lên Diễn đàn nhà phát triển API.