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

Bạn có thể tạo và chỉnh sửa các chính sách trên máy bằng văn bản mà mình yêu thích, trình chỉnh sửa hoặc IDE nhận biết XML. Chủ đề này sử dụng loại chính sách 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à kiểm tra chính sách.

Hầu hết proxy API đều thực thi hạn mức. Hạn mức cung cấp quyền kiểm soát đối với 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 về Hạn mức là được định cấu hình để giới hạn các ứng dụng ở 1 yêu cầu mỗi phút. (Mặc dù điều này có thể không thực tế, nhưng cung cấp một cách đơn giản để xem tác động của một chính sách.)

Trong cấu hình proxy API, 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ụ: chính sách thuộc loại Hạn mức được gọi là "Định mức" có thể được tạo dưới dạng một tệp có tên 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 có thể tạo chính sách qua lược đồ XML. Tất cả chính sách có một số chế độ cài đặt dành riêng cho loại chính sách và một số chế độ cài đặt chung cho tất cả các chính sách.

Khi bạn đính kèm các chính sách vào giao diện người dùng quản lý, trình tạo proxy API sẽ tạo 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 phần tử trong cấu hình chính sách, để cho rõ ràng, không phải lúc nào cũng được đưa vào tài liệu.

Tất cả chính sách đều xác định các thuộc tính sau:

  • enabled: Cho biết liệu chính sách có đang "bật" hay không hoặc "tắt". Chính sách có thể là bật/tắt trong thời gian chạy bằng cách thay đổi chế độ cài đặt này. Một chính sách có enabled đặt thành false sẽ không được thực thi.
  • continueOnError: Xác định xem quy trình có nên tiếp tục xử lý nếu chính sách không thành công. Khi thực thi chính sách về hạn mức, có thể xảy ra lỗi cho biết rằng đã vượt quá hạn mức và do đó, thuộc tính này phải được đặt thành false.
  • name: Tên mà bạn đặt cho chính sách này. Đây là tên duy nhất của thực thể chính sách và được dùng để đính kèm chính sách vào quy trình ở 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 về Hạn mức. Các phần tử này cung cấp chế độ cài đặt mà API Dịch vụ 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 mà bạn có thể tìm hiểu trong Tài liệu tham khảo về chính sách.