การแนบและกำหนดค่านโยบายในไฟล์ XML

คุณกำลังดูเอกสารประกอบ Apigee Edge
ไปที่ เอกสารประกอบเกี่ยวกับ Apigee X. ข้อมูล

คุณสร้างและแก้ไขนโยบายในเครื่องได้โดยใช้ข้อความสุดโปรด เครื่องมือแก้ไข XML หรือ IDE หัวข้อนี้ใช้ประเภทนโยบายโควต้าเป็นตัวอย่างวิธีการสร้าง กำหนดค่า แนบ ทำให้ใช้งานได้ และทดสอบนโยบาย

พร็อกซี API ส่วนใหญ่บังคับใช้โควต้า โควต้าช่วยให้ควบคุมความถี่ที่แอปไคลเอ็นต์ ได้รับอนุญาตให้เรียกใช้ API ในช่วงเวลาที่กำหนด ในตัวอย่างด้านล่าง นโยบายโควต้าคือ กำหนดค่าให้จำกัดแอปเป็น 1 คำขอต่อนาที (แม้ว่าสิ่งนี้อาจไม่สมจริงนัก ให้วิธีง่ายๆ ในการดูผลของนโยบาย)

ในการกำหนดค่าพร็อกซี API ไฟล์นโยบายจะจัดเก็บเป็นไฟล์ XML ภายใต้ ไดเรกทอรี /apiproxy/policies

เช่น นโยบายประเภทโควต้าที่ชื่อว่า "BidPolicy" สามารถสร้างเป็นไฟล์ชื่อ 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 นโยบายประเภทอื่นๆ จะมีการตั้งค่าของตัวเอง ซึ่งคุณจะ ดูข้อมูลได้ในข้อมูลอ้างอิงนโยบาย