Đí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.
Chuyển đến tài liệu về Apigee X.
thông tin

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

  1. Định cấu hình cho một loại chính sách.
  2. Đính kèm bản sao chính sách vào một Flow.

Biểu đồ 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ới Flow dưới dạng "Bước" của quá trình xử lý. Để định cấu hình hành vi mong muốn cho API, bạn cần tìm hiểu một chút về 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 các chính sách và quy trình

Một loại chính sách thường được sử 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 ngột, có khả năng đã làm đảo lộn các dịch vụ phụ trợ của bạn.

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

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

  1. Chọn một proxy API rồi chuyển đến chế độ xem Phát triển.
  2. Trong Trình chỉnh sửa proxy API, hãy chọn quy trình mà bạn muốn đính kèm chính sách trong ngăn Trình điều hướng.
    Ví dụ: luồng PreFlow được chọn cho điểm cuối của proxy API mặc định trong hình sau:
    Chọn quy trình mà bạn muốn đính kèm chính sách
  3. Trong chế độ xem Design (Thiết kế), hãy nhấp vào +Step (+Bước) liên kết với quy trình 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 và cho thấy một danh sách các chính sách đã được phân loại.
    Danh sách chính sách trong các danh mục
  4. Di chuyển rồi chọn loại chính sách mà bạn muốn áp dụng cho quy trình đã chọn.
  5. Sửa đổi các trường sau.
    • Tên hiển thị: Tên hiển thị duy nhất của 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 tên mô tả cho chính sách này. Việc này giúp đảm bảo 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 riêng biệt của chính sách. Tên chính sách khớp với tên hiển thị với các trường hợp ngoại lệ 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 được thay thế bằng một dấu gạch ngang duy nhất.

      • 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 là chữ và số, chẳng hạn như ký hiệu dấu thăng, ký hiệu phần trăm, ký hiệu "&", v.v. đều bị xoá.

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

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

Sau khi đính kèm chính sách, bạn sẽ thấy chính sách hiển thị trong chế độ xem Designer (Nhà thiết kế) cho quy trình, trong ví dụ này là PreFlow của điểm cuối proxy mặc định và trong danh sách Chính sách trong ngăn Navigation (Điều hướng). Chế độ xem Code (Mã) hiển thị XML cho chính sách mới đính kèm, xuất hiện bên dưới chế độ xem Designer (Nhà thiết kế). Edge tạo một thực thể 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 dành cho nhà thiết kế và mã

Thêm một chính sách mà không cần đính kèm vào 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 quy trình (giúp ích cho việc Xử lý lỗi), hãy nhấp vào dấu + trong thanh Chính sách trong chế độ xem Trình điều hướng để mở hộp thoại Thêm chính sách rồi thêm chính sách (như mô tả trong các bước từ 4 đến 6 trong phần trước).

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

Chính sách không được đính kèm với bất kỳ quy trình nào sẽ bị gắn cờ bằng biểu tượng "tách biệt" 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 trình bày 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 Chính sách vào quy trình mong muốn trong chế độ xem Nhà thiết kế.

Tách chính sách khỏi một luồng

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

Xoá trường hợp 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 của chính sách trong khung hiển thị Trình điều hướng. Nhấp vào dấu 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 giao diện người dùng tạo một thực thể chính sách, nó 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 những 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 trực tiếp chỉnh sửa cấu hình XML của chính sách đó trong chế độ xem Code (Mã). Ví dụ: ban đầu, tốc độ tin nhắn cao nhất cho chính sách Tăng đột biến được đặt thành 30 thông báo mỗi giây. Bạn có thể thay đổi tốc độ cao nhất bằng cách thay đổi giá trị của phần tử <Rate> trong tệp XML cho chính sách. Để biết thêm thông tin 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 Code (Mã). Đây là một cách tuyệt vời để sử dụng lại các chính sách từ các mẫu có sẵn trên GitHub.

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

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