Đí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.
Truy cập vào tài liệu 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 trình chỉnh sửa văn bản hoặc trình chỉnh sửa/IDE nhận biết XML mà bạn yêu thích. 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 thử chính sách.

Hầu hết các proxy API đều thực thi một hạn mức. Hạn mức giúp kiểm soát tần suất mà 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ù điều này có thể không thực tế, nhưng nó cung cấp một cách đơn giản để xem các hiệu ứng của một chính sách.)

Trong cấu hình của một 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ụ: bạn có thể tạo một chính sách thuộc loại Hạn mức có tên là "QuotaPolicy" dưới dạng một 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ự tạo tệp văn bản hoặc tạo chính sách từ mộ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 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 trong giao diện người dùng quản lý, trình tạo proxy API sẽ tạo phiên bản 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 mà, để cho rõ ràng, không phải lúc nào cũng có trong tài liệu.

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

  • enabled: Cho biết chính sách đang ở trạng thái "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 có enabled được đặ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ý thông báo nếu chính sách không thành công hay không. Khi thực thi các chính sách về hạn mức, lỗi có thể cho biết rằng hạn mức đã bị vượt quá và do đó, bạn nên đặt thuộc tính này thành false.
  • name: Tên mà bạn đặt cho chính sách này. Tên này là duy nhất cho phiên bản chính sách này và được dùng để đính kèm chính sách vào luồng 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 những chế độ cài đặt mà Dịch vụ API thực thi thay cho một API. Các loại chính sách khác sẽ xác định chế độ cài đặt riêng. Bạn có thể tìm hiểu về các chế độ cài đặt này trong phần Tài liệu tham khảo về chính sách.