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.
Truy cập vào tài liệu Apigee X.
thông tin

Luồng dùng chung là chức năng có thể dùng lại, tương tự như một proxy API. Nếu đã quen thuộc với các proxy API, thì bạn sẽ thấy nhiều nội dung trong tài liệu tham khảo này quen thuộc.

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

Cấu trúc gói luồng được chia sẻ

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

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

Các thành phần trong bảng trên được xác định bằng 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 một gói luồng dùng chung.

Cấu hình cơ bản

Tệp cấu hình cơ sở nằm trong thư mục gốc của gói. Tên của nhóm 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ơ bản

Tên 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 dùng các ký tự sau trong tên: A-Za-z0-9_- Không áp dụng
revision Số phiên bản của cấu hình gói quy trình dùng chung. Bạn không cần phải đặt rõ ràng số phiên bản, vì Apigee Edge sẽ tự động theo dõi phiên bản hiện tại của luồng dùng chung. Không áp dụng Không

Các phần tử cấu hình cơ bản

Tên 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. Hiện tại, giá trị được hỗ trợ duy nhất là majorVersion 4 và minorVersion 0. Chế độ cài đặt này có thể được 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
CreatedAtCreatedBy Ngày/giờ (theo thời gian bắt đầu tính từ thời điểm 00:00:00 ngày 1 tháng 1 năm 1970) 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 đó.
Description Nội dung mô tả bằng văn bản về luồng được chia sẻ. Nếu được cung cấp, nội dung mô tả sẽ xuất hiện trong giao diện người dùng quản lý Edge. Không áp dụng Không
DisplayName Một 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
LastModifiedAtLastModifiedBy Ngày/giờ (theo thời gian bắt đầu tính từ ngày 1 tháng 1 năm 1970) 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 luồng chia sẻ 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 "manifest" (tệp kê khai), được thiết kế để cung cấp thông tin về nội dung của luồng dùng chung. Không áp dụng Không
Resources Danh sách các tài nguyên (JavaScript, Python, Java, XSLT) trong thư mục /resources của luồng 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 "manifest" (tệp kê khai), được thiết kế để cung cấp thông tin về 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 mà gói này chứa.

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

Không áp dụng

Luồng dùng chung

/sharedflowbundle/sharedflows/default.xml

Cấu hình SharedFlow xác định trình tự thực thi các phần tử luồng. Mỗi phần tử con <Step> của phần tử <SharedFlow> đều chỉ định một phần của trình tự, chẳng hạn như một lệnh gọi đến 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ý), trong đó chính sách Chống đột biến là chính sách đầu tiên và chính sách Lời gọi chú thích luồng là chính sách 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 Mô tả Mặc định Bắt buộc?
SharedFlow
name Tên của luồng dùng chung, phải là duy nhất trong một tổ chức. Bạn chỉ được phép dùng các ký tự sau trong tên: A-Za-z0-9_- Không áp dụng
revision Số phiên bản của cấu hình luồng dùng chung. Bạn không cần đặt rõ ràng số phiên bản, vì Apigee Edge tự động theo dõi phiên bản hiện tại của luồng dùng chung. Không áp dụng Không

Các phần tử cấu hình luồng dùng chung

Tên Mô tả Mặc định Bắt buộc?
SharedFlow Xác định trình tự của các chính sách trong quy trình dùng chung. Không áp dụng
Step Xác định một bước – một giai đoạn trong trình tự của quy trình. Không áp dụng
Name Chỉ định tên của mục mà bước này tham chiếu. Giá trị của phần tử này phải giống với giá trị nhận dạng riêng biệ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

Chính sách

/sharedflowbundle/policies

Giống như trong một proxy API, trong gói luồng dùng chung, thư mục /policies chứa XML cấu hình cho tất cả các chính sách có thể được đính kèm vào luồng dùng chung trong gói. Các chính sách có một nhóm nhỏ các phần tử chung, mặc dù nhóm nhỏ này được bổ sung các phần tử dành riêng cho chính sách. Để biết thêm về cách định cấu hình một chính sách, hãy xem chủ đề về chính sách mà bạn muốn. Bạn cũng có thể truy cập vào các chính sách này trong phần Thông tin 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 biến đổi XSL có thể được đính kèm vào các luồng dùng chung bằng cách sử dụng chính sách. Các đoạn mã này xuất hiện trong phần Tập lệnh của trình chỉnh sửa luồng được chia sẻ trong giao diện người dùng quản lý.

Hãy xem 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 Apigee.