Đính kèm và định cấu hình chính sách trong tệp XML

Bạn đang xem tài liệu về Apigee Edge.
Tham khảo tài liệu về Apigee X. thông tin

Bạn có thể tạo và chỉnh sửa chính sách cục bộ bằng cách sử dụng văn bản yêu thích hoặc trình chỉnh sửa nhận biết XML hoặc IDE. Chủ đề này sử dụng loại chính sách về Hạn mức làm ví dụ về cách tạo, định cấu hình, đính kèm, triển khai và thử nghiệm chính sách.

Hầu hết proxy API đều thực thi hạn mức. Hạn mức cho phép kiểm soát tần suất một ứng dụng khách được phép gọi một API trong một khoảng thời gian nhất định. Trong ví dụ bên dưới, chính sách Hạn mức được định cấu hình để giới hạn ứng dụng ở mức 1 yêu cầu mỗi phút. (Mặc dù cách này có thể không thực tế, nhưng cách làm này giúp bạn dễ dàng biết được tác động của một chính sách.)

Trong cấu hình proxy API, các tệp Chính sách được lưu trữ dưới dạng tệp XML trong thư mục /apiproxy/policies.

Ví dụ: hệ thống có thể tạo chính sách thuộc loại Hạn mức có tên là "QuotaPolicy" dưới dạng tệp có tên là QuotaPolicy.xml với nội dung sau:

<Quota enabled="true" continueOnError="false" name="QuotaPolicy">
    <Allow count="1"/>
    <Interval>1</Interval>
    <TimeUnit>minute</TimeUnit>
</Quota>

Bạn có thể tạo tệp văn bản theo cách thủ công hoặc tạo chính sách từ giản đồ XML. Tất cả các chính sách đều có một số chế độ cài đặt dành riêng cho loại chính sách, còn một số chế độ cài đặt chung cho mọi chính sách.

Khi bạn đính kèm các chính sách trong giao diện người dùng quản lý, trình tạo proxy API sẽ tạo thực thể chính sách từ giản đồ XML cho loại chính sách mà bạn đã chọn. Do đó, bạn có thể thấy các yếu tố trong cấu hình chính sách mà không phải lúc nào cũng được đưa vào tài liệu.

Mọi chính sách đều xác định các thuộc tính sau:

  • enabled: Cho biết chính sách đang "bật" hay "tắt". Bạn có thể bật/tắt các chính sách trong thời gian chạy bằng cách thay đổi chế độ cài đặt này. Chính sách đã đặt enabled thành false sẽ không được thực thi.
  • continueOnError: Xác định xem quy trình có tiếp tục xử lý thông báo nếu chính sách không thành công hay không. Khi thực thi chính sách hạn mức, các lỗi có thể cho biết rằng hạn mức đã bị vượt quá hạn mức và do đó, bạn phải đặt thuộc tính này thành false.
  • name: Tên mà bạn đặt cho chính sách này. Đây là tên dành riêng cho trường hợp chính sách này và được dùng để đính kèm chính sách vào quy trình dưới dạng một bước xử lý.

Trong ví dụ trên, các phần tử Allow, Interval và TimeUnit dành riêng cho chính sách Hạn mức. Các phần tử này cung cấp các chế độ cài đặt mà Dịch vụ API thực thi thay mặt cho API. Các loại chính sách khác xác định chế độ cài đặt riêng. Bạn có thể tìm hiểu về các chế độ này trong Tài liệu tham khảo về chính sách.