คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X ข้อมูล
คุณสามารถสร้างและแก้ไขนโยบายในเครื่องได้โดยใช้ข้อความหรือโปรแกรมแก้ไขแบบ XML-Aware หรือ IDE ที่คุณชื่นชอบ หัวข้อนี้ใช้ประเภทนโยบายโควต้าเป็นตัวอย่างของวิธีสร้าง กำหนดค่า แนบ ทำให้ใช้งานได้ และทดสอบนโยบาย
พร็อกซี API ส่วนใหญ่บังคับใช้โควต้า โควต้าช่วยให้ควบคุมความถี่ที่แอปไคลเอ็นต์เรียกใช้ API ในช่วงเวลาที่กำหนดได้ ในตัวอย่างด้านล่าง มีการกำหนดค่านโยบายโควต้าให้จำกัดแอปไว้ที่ 1 คำขอต่อนาที (แม้ว่าวิธีนี้อาจไม่สมจริง แต่ก็เป็นวิธีง่ายๆ ในการดูผลกระทบของนโยบาย)
ในการกำหนดค่าพร็อกซี API ระบบจะเก็บไฟล์นโยบายเป็นไฟล์ XML ไว้ภายใต้ไดเรกทอรี /apiproxy/policies
เช่น คุณอาจสร้างนโยบายประเภทโควต้าที่ชื่อ "QuotaPolicy" เป็นไฟล์ชื่อ QuotaPolicy.xml
ที่มีเนื้อหาต่อไปนี้
<Quota enabled="true" continueOnError="false" name="QuotaPolicy"> <Allow count="1"/> <Interval>1</Interval> <TimeUnit>minute</TimeUnit> </Quota>
คุณจะสร้างไฟล์ข้อความด้วยตนเอง หรือสร้างนโยบายจากสคีมา XML ก็ได้ นโยบายทั้งหมดมีการตั้งค่าบางอย่างที่ใช้กับนโยบายบางประเภทโดยเฉพาะ รวมถึงการตั้งค่าบางอย่างที่เป็นแบบทั่วไปในนโยบายทั้งหมด
นโยบายทั้งหมดจะกำหนดแอตทริบิวต์ต่อไปนี้
enabled
: ระบุว่านโยบายมีการ "เปิด" หรือ "ปิด" คุณเปิดใช้/ปิดใช้นโยบายขณะรันไทม์ได้โดยเปลี่ยนการตั้งค่านี้ นโยบายที่ตั้งค่าenabled
เป็นfalse
จะไม่มีการบังคับใช้continueOnError
: กำหนดว่าไปป์ไลน์ควรประมวลผลข้อความต่อไปหรือไม่หากนโยบายล้มเหลว เมื่อบังคับใช้นโยบายโควต้า ข้อผิดพลาดอาจบ่งชี้ว่ามีการใช้งานเกินขีดจำกัดแล้ว จึงควรตั้งค่าแอตทริบิวต์นี้เป็น "เท็จ"name
: ชื่อที่คุณตั้งให้กับนโยบายนี้ ชื่อนี้จะไม่ซ้ำกันสำหรับอินสแตนซ์นโยบายนี้ และใช้เพื่อแนบนโยบายกับโฟลว์ในฐานะขั้นตอนการประมวลผล
ในตัวอย่างข้างต้น องค์ประกอบ Allow
, Interval
และ TimeUnit
มีไว้สำหรับนโยบายโควต้าเท่านั้น องค์ประกอบเหล่านี้มีการตั้งค่าที่บริการ API บังคับใช้ในนามของ API นโยบายประเภทอื่นๆ จะกำหนดการตั้งค่าของตนเอง ซึ่งคุณจะดูข้อมูลได้ในข้อมูลอ้างอิงนโยบาย