Đính kèm và định cấu hình chính sách trong giao diện người dùng

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

Thêm các chức năng dựa trên chính sách vào một proxy API là quy trình gồm 2 bước:

  1. Định cấu hình một phiên bản của loại chính sách.
  2. Đính kèm thực thể chính sách vào một Flow.

Sơ đồ dưới đây cho thấy mối quan hệ giữa các chính sách và Luồng. Như bạn có thể thấy, một chính sách được đính kèm vào một Luồng dưới dạng "Bước" xử lý. Để định cấu hình hành vi mong muốn cho API, bạn cần hiểu rõ một chút về các Flow. (Chủ đề này đã được đề cập trước đó trong phần Định cấu hình quy trình.)

Mối quan hệ giữa chính sách và luồng

Một loại chính sách thường được dùng là SpikeArrest. SpikeArrest ngăn chặn tình trạng lưu lượng truy cập tin nhắn tăng đột biến có thể làm quá tải các dịch vụ phụ trợ của bạn.

Đính kèm chính sách vào một quy trình

Cách đính kèm chính sách vào một Luồng:

  1. Chọn một proxy API rồi chuyển đến chế độ xem Phát triển.
  2. Trong API Proxy Editor, hãy chọn luồng mà bạn muốn đính kèm một chính sách trong ngăn Navigator.
    Ví dụ: luồng PreFlow được chọn cho điểm cuối proxy API mặc định trong hình sau:
    Chọn luồng mà bạn muốn đính kèm chính sách
  3. Trong khung hiển thị Thiết kế, hãy nhấp vào +Bước được liên kết với luồng yêu cầu hoặc phản hồi để đính kèm một chính sách. Ví dụ:
    Nhấp vào + Bước
    Hộp thoại Thêm bước sẽ mở ra, cho thấy danh sách chính sách theo danh mục.
    Danh sách các chính sách theo danh mục
  4. Di chuyển xuống và chọn loại chính sách mà bạn muốn đính kèm vào luồng đã chọn.
  5. Sửa đổi các trường sau.

    • Tên hiển thị: Tên hiển thị riêng biệt cho chính sách. Giao diện người dùng sẽ tạo tên mặc định, nhưng bạn nên tạo một tên mô tả cho chính sách. Điều này sẽ giúp các nhà phát triển khác trong tổ chức của bạn dễ dàng hiểu được mục đích của chính sách.

    • Tên: Tên duy nhất của chính sách. Tên chính sách khớp với tên hiển thị, ngoại trừ những trường hợp sau:

      • Dấu cách được thay thế bằng dấu gạch ngang.

      • Các dấu gạch ngang liên tiếp sẽ được thay thế bằng một dấu gạch ngang.

      • Ngoại trừ dấu gạch ngang, dấu gạch dưới và dấu cách (được thay thế như đã lưu ý ở trên), các ký tự không phải chữ và số (chẳng hạn như dấu thăng, dấu phần trăm, dấu và, v.v.) sẽ bị xoá.

  6. Nhấp vào Thêm.

    Chính sách này được đính kèm vào quy trình đã chọn.

Sau khi đính kèm chính sách, bạn sẽ thấy chính sách xuất hiện trong chế độ xem Designer (Trình thiết kế) cho luồng. Trong ví dụ này, đó là PreFlow (Luồng trước) của điểm cuối proxy mặc định và trong danh sách Policies (Chính sách) trong ngăn điều hướng. Chế độ xem Code (Mã) (hiển thị XML cho chính sách mới được đính kèm) sẽ xuất hiện bên dưới chế độ xem Designer (Trình thiết kế). Edge tạo một phiên bản của chính sách chứa một tập hợp các giá trị mặc định hợp lý.

Các chính sách trong PreFlow ở chế độ xem Trình thiết kế và Chế độ xem mã

Thêm chính sách mà không đính kèm vào một quy trình

Để thêm một chính sách mà không cần đính kèm chính sách đó vào một luồng (hữu ích cho việc Xử lý lỗi), hãy nhấp vào + trong thanh Policies (Chính sách) trong chế độ xem Navigator (Trình điều hướng) để mở hộp thoại Add Policy (Thêm chính sách) và thêm chính sách (như mô tả trong các bước từ 4 đến 6 ở phần trước).

Nhấp vào dấu + để thêm chính sách

Một chính sách không được đính kèm vào bất kỳ luồng nào sẽ được gắn cờ bằng biểu tượng "đã tách" trong danh sách Chính sách, như minh hoạ bên cạnh chính sách về thông báo khoá API trong hình trước.

Sau khi tạo chính sách, bạn có thể đính kèm chính sách đó vào một quy trình bằng cách kéo và thả chính sách đó từ danh sách Policies (Chính sách) vào quy trình mong muốn trong chế độ xem Designer (Trình thiết kế).

Huỷ liên kết chính sách với một quy trình

Để tách một chính sách khỏi một Luồng, hãy chọn Luồng đó. Di chuột qua biểu tượng chính sách trong chế độ xem Nhà thiết kế của Luồng. Nhấp vào biểu tượng X trong vòng tròn xuất hiện trong biểu tượng.

Xoá một phiên bản chính sách

Để xoá một phiên bản chính sách, hãy di chuột qua mục nhập cho chính sách đó trong chế độ xem Navigator (Trình điều hướng). Nhấp vào biểu tượng X trong vòng tròn xuất hiện ở bên phải mục nhập.

Định cấu hình chính sách trong giao diện người dùng

Khi tạo một phiên bản chính sách, giao diện người dùng sẽ áp dụng các giá trị mặc định hợp lý cho các chế độ cài đặt phổ biến. Bạn có thể cần sửa đổi các chế độ cài đặt này để đáp ứng yêu cầu của mình.

Ví dụ: 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<SpikeArrest async="false" continueOnError="false" enabled="true" name="spikearrest-1">
  <DisplayName>SpikeArrest-1</DisplayName>
  <FaultRules/>
  <Properties/>
  <Identifier ref="request.header.some-header-name"/>
  <MessageWeight ref="request.header.weight"/>
  <Rate>30ps</Rate>
</SpikeArrest>

Bạn có thể định cấu hình một chính sách bằng cách chỉnh sửa trực tiếp cấu hình XML của chính sách đó trong chế độ xem Code (Mã). Ví dụ: tốc độ gửi tin nhắn cao nhất cho chính sách Chặn đột biến ban đầu được đặt thành 30 tin nhắn mỗi giây. Bạn có thể thay đổi tốc độ tối đa bằng cách thay đổi giá trị phần tử <Rate> trong XML cho chính sách. Để biết thêm thông tin chi tiết về cách định cấu hình chính sách, hãy xem Tài liệu tham khảo về chính sách.

Bạn cũng có thể cắt và dán các chính sách vào chế độ xem Mã. Đây là một cách hiệu quả để sử dụng lại các chính sách từ các mẫu có trên GitHub.

Khi bạn thay đổi định nghĩa chính sách trong chế độ xem Mã, các thay đổi sẽ xuất hiện trong Trình kiểm tra thuộc tính. Điều này cũng đúng theo chiều ngược lại – thực hiện các thay đổi trong Property Inspector (Trình kiểm tra thuộc tính) và các thay đổi đó sẽ xuất hiện trong XML ở chế độ xem Code (Mã).

Để xem tài liệu cụ thể về Chính sách hạn mức được dùng trong chủ đề này, hãy xem Chính sách hạn mức.