นโยบายโควต้า

คุณกําลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X info

อะไร

ใช้นโยบายโควต้าเพื่อกำหนดค่าจำนวนข้อความคำขอที่พร็อกซี API อนุญาตในช่วงเวลาหนึ่งๆ เช่น นาที ชั่วโมง วัน สัปดาห์ หรือเดือน คุณสามารถตั้งค่าโควต้าให้เหมือนกันสำหรับแอปทั้งหมดที่เข้าถึงพร็อกซี API หรือจะตั้งค่าโควต้าตามเกณฑ์ต่อไปนี้ก็ได้

• ผลิตภัณฑ์ที่มีพร็อกซี API
• แอปที่ขอ API
• นักพัฒนาแอป
• เกณฑ์อื่นๆ อีกมากมาย

อย่าใช้โควต้าเพื่อปกป้องจากปริมาณการเข้าชมโดยรวมที่เพิ่มขึ้นอย่างรวดเร็ว โปรดใช้นโยบายการหยุดการเพิ่มขึ้นอย่างฉับพลัน ดูนโยบายการหยุดการเพิ่มขึ้นอย่างฉับพลัน

วิดีโอ

วิดีโอเหล่านี้จะแนะนำการจัดการโควต้าด้วยนโยบายโควต้า

ตัวอย่าง

ตัวอย่างโค้ดนโยบายเหล่านี้แสดงวิธีเริ่มต้นและสิ้นสุดระยะเวลาโควต้าโดยทำดังนี้

<Quota name="CheckQuota"> 
  <Interval ref="verifyapikey.verify-api-key.apiproduct.developer.quota.interval">1</Interval>
  <TimeUnit ref="verifyapikey.verify-api-key.apiproduct.developer.quota.timeunit">hour</TimeUnit>
  <Allow count="200" countRef="verifyapikey.verify-api-key.apiproduct.developer.quota.limit"/>
</Quota>

<Quota name="DeveloperQuota"> 
  <Identifier ref="verifyapikey.verify-api-key.client_id"/> 
  <Interval ref="verifyapikey.verify-api-key.developer.timeInterval"/> 
  <TimeUnit ref="verifyapikey.verify-api-key.developer.timeUnit"/> 
  <Allow countRef="verifyapikey.verify-api-key.developer.limit"/> 
</Quota>

<Quota name="QuotaPolicy" type="calendar">
  <StartTime>2017-02-18 10:30:00</StartTime>
  <Interval>5</Interval>
  <TimeUnit>hour</TimeUnit>
  <Allow count="99"/>
</Quota>

<Quota name="QuotaPolicy">
  <Interval>5</Interval>
  <TimeUnit>hour</TimeUnit>
  <Allow count="99"/>
</Quota>

<AssignMessage async="false" continueOnError="false" enabled="true" name="ReturnQuotaVars">
    <AssignTo createNew="false" type="response"/>
    <Set>
        <Headers>
            <Header name="QuotaLimit">{ratelimit.QuotaPolicy.allowed.count}</Header>
            <Header name="QuotaUsed">{ratelimit.QuotaPolicy.used.count}</Header>
            <Header name="QuotaResetUTC">{ratelimit.QuotaPolicy.expiry.time}</Header>
        </Headers>
    </Set>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
</AssignMessage>

<Quota name="MyQuota">
  <Interval>1</Interval>
  <TimeUnit>hour</TimeUnit>
  <Allow count="10000"/>
</Quota>

<Quota name="QuotaPolicy" type="calendar">
  <Identifier ref="request.header.clientId"/> 
  <StartTime>2017-02-18 10:00:00</StartTime>
  <Interval>5</Interval>
  <TimeUnit>hour</TimeUnit>
  <Allow count="99"/>
</Quota>

<Identifier ref="request.queryparam.id"/>

<Identifier ref="verifyapikey.verify-api-key.client_id"></Identifier>

<Quota name="QuotaPolicy">
  <Interval>1</Interval>
  <TimeUnit>day</TimeUnit>
  <Allow>
    <Class ref="request.header.developer_segment">
      <Allow class="platinum" count="10000"/>
      <Allow class="silver" count="1000" />
    </Class>
  </Allow>
</Quota>

เกี่ยวกับนโยบายโควต้า

โควต้าคือการจัดสรรข้อความคําขอที่พร็อกซี API สามารถจัดการได้ในช่วงระยะเวลาหนึ่ง เช่น นาที ชั่วโมง วัน สัปดาห์ หรือเดือน นโยบายจะดูแลรักษาตัวนับที่นับจํานวนคําขอที่ได้รับจากพร็อกซี API ความสามารถนี้ช่วยให้ผู้ให้บริการ API สามารถบังคับใช้ขีดจํากัดเกี่ยวกับจํานวนการเรียก API ที่แอปทําในช่วงเวลาหนึ่ง การใช้นโยบายโควต้าช่วยให้คุณจำกัดแอปให้มีคำขอได้ 1 คำขอต่อนาที หรือ 10,000 คำขอต่อเดือน เป็นต้น

เช่น หากกำหนดโควต้าเป็น 10,000 ข้อความต่อเดือน การจำกัดอัตราการส่งจะเริ่มขึ้นหลังจากข้อความที่ 10,001 ไม่ว่าระบบจะนับข้อความ 10,000 รายการในวันแรกหรือวันสุดท้ายของระยะเวลาดังกล่าว ระบบจะไม่อนุญาตให้ส่งคำขอเพิ่มเติมจนกว่าตัวนับโควต้าจะรีเซ็ตโดยอัตโนมัติเมื่อสิ้นสุดช่วงเวลาที่ระบุ หรือจนกว่าจะมีการรีเซ็ตโควต้าอย่างชัดเจนโดยใช้นโยบายรีเซ็ตโควต้า

รูปแบบหนึ่งของโควต้าที่เรียกว่า SpikeArrest จะป้องกันไม่ให้มีการเข้าชมเพิ่มขึ้นอย่างรวดเร็ว (หรือเพิ่มขึ้นอย่างฉับพลัน) ซึ่งอาจเกิดจากการใช้งานที่เพิ่มขึ้นอย่างฉับพลัน ไคลเอ็นต์ที่มีข้อบกพร่อง หรือการโจมตีที่เป็นอันตราย ดูข้อมูลเพิ่มเติมเกี่ยวกับ SpikeArrest ได้ที่นโยบาย SpikeArrest

โควต้าจะมีผลกับพร็อกซี API แต่ละรายการและจะไม่กระจายไปยังพร็อกซี API อื่นๆ ตัวอย่างเช่น หากคุณมีพร็อกซี API 3 ตัวในผลิตภัณฑ์ API หนึ่งๆ ระบบจะไม่ใช้โควต้าเดียวกันกับทั้ง 3 ตัว แม้ว่าทั้ง 3 ตัวจะใช้การกำหนดค่านโยบายโควต้าเดียวกันก็ตาม

ประเภทนโยบายโควต้า

นโยบายโควต้ารองรับนโยบายหลายประเภท ได้แก่ เริ่มต้น, calendar, flexi และ rollingwindow แต่ละประเภทจะกำหนดว่าตัวนับโควต้าจะเริ่มทำงานเมื่อใดและรีเซ็ตเมื่อใด ดังที่แสดงในตารางต่อไปนี้

สําหรับ type="calendar" คุณต้องระบุค่าของ <StartTime>

ตารางไม่ได้แสดงค่าสำหรับประเภท rollingwindow โควต้าแบบเลื่อนไปเรื่อยๆ โควต้าจะทํางานโดยกําหนดขนาดของ "กรอบเวลา" ของโควต้า เช่น กรอบเวลา 1 ชั่วโมงหรือ 1 วัน เมื่อได้รับคำขอใหม่ นโยบายจะระบุว่ามีการใช้โควต้าเกิน "กรอบเวลา" ที่ผ่านมาหรือไม่

เช่น คุณกำหนดกรอบเวลา 2 ชั่วโมงที่อนุญาตคำขอ 1, 000 รายการ คำขอใหม่เข้ามาเวลา 16:45 น.นโยบายจะคำนวณจำนวนโควต้าสำหรับกรอบเวลา 2 ชั่วโมงที่ผ่านมา ซึ่งก็คือจํานวนคําขอนับตั้งแต่ 14:45 น. หากไม่ได้ใช้โควต้าเกินขีดจํากัดในกรอบเวลา 2 ชั่วโมงดังกล่าว ระบบจะอนุญาตคําขอ

1 นาทีต่อมา เวลา 16:46 น. มีคำขออีกรายการเข้ามา ตอนนี้นโยบายจะคํานวณจํานวนโควต้านับตั้งแต่เวลา 14:46 น. เพื่อพิจารณาว่าเกินขีดจํากัดหรือไม่

สําหรับประเภท rollingwindow ตัวนับจะไม่รีเซ็ต แต่จะคํานวณใหม่ในคําขอแต่ละรายการ

ทำความเข้าใจตัวนับโควต้า

โดยค่าเริ่มต้น นโยบายโควต้าจะเก็บรักษาตัวนับรายการเดียว ไม่ว่าคุณจะอ้างอิงนโยบายในพร็อกซี API กี่ครั้งก็ตาม ชื่อตัวนับโควต้าจะอิงตามแอตทริบิวต์ name ของนโยบาย

เช่น คุณสร้างนโยบายโควต้าชื่อ MyQuotaPolicy ที่มีขีดจํากัด 5 คำขอ และวางไว้ในหลายเวิร์กโฟลว์ (เวิร์กโฟลว์ ก, ข และ ค) ในพร็อกซี API แม้ว่าจะใช้ในหลายขั้นตอน แต่ก็มีตัวนับเดียวที่อินสแตนซ์ทั้งหมดของนโยบายจะอัปเดต

• โฟลว์ ก ทำงาน -> MyQuotaPolicy ทำงานและตัวนับ = 1
• โฟลว์ ข ทำงาน -> MyQuotaPolicy ทำงานและตัวนับ = 2
• โฟลว์ ก ทำงาน -> MyQuotaPolicy ทำงานและตัวนับ = 3
• โฟลว์ C ทำงาน -> MyQuotaPolicy ทำงานและตัวนับ = 4
• โฟลว์ ก ทำงาน -> MyQuotaPolicy ทำงานและตัวนับ = 5

ระบบจะปฏิเสธคำขอถัดไปสำหรับโฟลว์ใดโฟลว์หนึ่งเนื่องจากตัวนับโควต้าถึงขีดจำกัดแล้ว

การใช้นโยบายโควต้าเดียวกันในหลายตำแหน่งในเวิร์กโฟลว์พร็อกซี API ซึ่งอาจทำให้โควต้าหมดเร็วกว่าที่คาดไว้โดยไม่ตั้งใจ เป็นรูปแบบที่ไม่แนะนำที่อธิบายไว้ในสมุดรูปแบบที่ไม่แนะนำของ Apigee Edge

หรือจะกําหนดนโยบายโควต้าหลายรายการในพร็อกซี API และใช้นโยบายที่แตกต่างกันในแต่ละเวิร์กโฟลว์ก็ได้ นโยบายโควต้าแต่ละรายการจะมีตัวนับของตัวเอง โดยอิงตามแอตทริบิวต์ name ของนโยบาย

หรือใช้องค์ประกอบ <Class> หรือ <Identifier> ในนโยบายโควต้าเพื่อกำหนดตัวนับที่ไม่ซ้ำกันหลายรายการในนโยบายเดียว การใช้องค์ประกอบเหล่านี้จะช่วยให้นโยบายเดียวสามารถเก็บรักษาตัวนับที่แตกต่างกันตามแอปที่ส่งคำขอ นักพัฒนาแอปที่ส่งคำขอ รหัสไคลเอ็นต์หรือตัวระบุไคลเอ็นต์อื่นๆ และอื่นๆ ดูข้อมูลเพิ่มเติมเกี่ยวกับการใช้องค์ประกอบ <Class> หรือ <Identifier> ได้จากตัวอย่างด้านบน

การเขียนเวลา

ระบบจะตั้งค่าเวลาโควต้าทั้งหมดเป็นเขตเวลาเวลาสากลเชิงพิกัด (UTC)

รูปแบบเวลาโควต้าเป็นไปตามรูปแบบวันที่มาตรฐานสากลที่ระบุไว้ในมาตรฐานสากล ISO 8601

วันที่จะกำหนดเป็นปี เดือน และวันในรูปแบบ YYYY-MM-DD เช่น 2015-02-04 แสดงถึงวันที่ 4 กุมภาพันธ์ 2015

เวลาของวันจะกำหนดเป็นชั่วโมง นาที และวินาทีในรูปแบบต่อไปนี้ hours:minutes:seconds ตัวอย่างเช่น 23:59:59 แสดงเวลา 1 วินาทีก่อนเที่ยงคืน

โปรดทราบว่ามีเครื่องหมาย 2 แบบ ได้แก่ 00:00:00 และ 24:00:00 เพื่อแยกแยะเวลาเที่ยงคืน 2 ครั้งที่เชื่อมโยงกับวันที่เดียวกันได้ ดังนั้น 2015-02-04 24:00:00 จึงเป็นวันและเวลาเดียวกับ 2015-02-05 00:00:00 โดยปกติแล้ว รูปแบบหลังจะเป็นรูปแบบที่แนะนำ

การรับการตั้งค่าโควต้าจากการกําหนดค่าผลิตภัณฑ์ API

คุณสามารถกำหนดขีดจำกัดโควต้าในการกำหนดค่าผลิตภัณฑ์ API ขีดจํากัดเหล่านั้นจะไม่บังคับใช้โควต้าโดยอัตโนมัติ แต่คุณสามารถอ้างอิงการตั้งค่าโควต้าผลิตภัณฑ์ในนโยบายโควต้าแทนได้ ต่อไปนี้คือข้อดีบางส่วนของการตั้งโควต้าในผลิตภัณฑ์เพื่อให้นโยบายโควต้าอ้างอิง

• นโยบายโควต้าสามารถใช้การตั้งค่าแบบเดียวกันกับพร็อกซี API ทั้งหมดในผลิตภัณฑ์ API
• คุณทำการเปลี่ยนแปลงรันไทม์ในการตั้งค่าโควต้าในผลิตภัณฑ์ API ได้ และนโยบายโควต้าที่อ้างอิงค่าจะมีค่าโควต้าที่อัปเดตโดยอัตโนมัติ

ดูข้อมูลเพิ่มเติมเกี่ยวกับการใช้การตั้งค่าโควต้าจากผลิตภัณฑ์ API ได้ที่ตัวอย่าง "โควต้าแบบไดนามิก" ด้านบน

ดูข้อมูลเกี่ยวกับการกำหนดค่าผลิตภัณฑ์ API ที่มีขีดจำกัดโควต้าได้ที่สร้างผลิตภัณฑ์ API

การอ้างอิงองค์ประกอบ

ต่อไปนี้คือองค์ประกอบและแอตทริบิวต์ที่คุณกำหนดค่าในนโยบายนี้ได้ โปรดทราบว่าการผสมองค์ประกอบบางอย่างจะแยกกันใช้ไม่ได้หรือไม่จำเป็น ดูตัวอย่างการใช้งานที่เฉพาะเจาะจง ตัวแปร verifyapikey.VerifyAPIKey.apiproduct.* ด้านล่างจะพร้อมใช้งานโดยค่าเริ่มต้นเมื่อใช้นโยบาย "VerifyAPIKey" เพื่อตรวจสอบคีย์ API ของแอปในคําขอ ค่าตัวแปรมาจากการตั้งค่าโควต้าในผลิตภัณฑ์ API ที่คีย์เชื่อมโยงอยู่ ตามที่อธิบายไว้ในการรับการตั้งค่าโควต้าจากการกําหนดค่าผลิตภัณฑ์ API

<Quota async="false" continueOnError="false" enabled="true" name="Quota-3" type="calendar">
   <DisplayName>Quota 3</DisplayName>
   <Allow count="2000" countRef="verifyapikey.VerifyAPIKey.apiproduct.developer.quota.limit"/>
   <Allow>
      <Class ref="request.queryparam.time_variable">
        <Allow class="peak_time" count="5000"/>
        <Allow class="off_peak_time" count="1000"/>
      </Class>
   </Allow>
   <Interval ref="verifyapikey.VerifyAPIKey.apiproduct.developer.quota.interval">1</Interval> 
   <TimeUnit ref="verifyapikey.VerifyAPIKey.apiproduct.developer.quota.timeunit">month</TimeUnit>
   <StartTime>2017-7-16 12:00:00</StartTime> 
   <Distributed>false</Distributed> 
   <Synchronous>false</Synchronous> 
   <AsynchronousConfiguration> 
      <SyncIntervalInSeconds>20</SyncIntervalInSeconds> 
      <SyncMessageCount>5</SyncMessageCount> 
   </AsynchronousConfiguration> 
   <Identifier/> 
   <MessageWeight/> 
</Quota>

แอตทริบิวต์ <Quota>

<Quota async="false" continueOnError="false" enabled="true" name="Quota-3" type="calendar">

แอตทริบิวต์ต่อไปนี้ใช้กับนโยบายนี้โดยเฉพาะ

The following table describes attributes that are common to all policy parent elements:

<DisplayName> element

Use in addition to the name attribute to label the policy in the management UI proxy editor with a different, natural-language name.

<DisplayName>Policy Display Name</DisplayName>

องค์ประกอบ <Allow>

ระบุขีดจํากัดจํานวนสำหรับโควต้า หากตัวนับของนโยบายถึงค่าขีดจํากัดนี้ ระบบจะปฏิเสธการเรียกใช้ครั้งต่อๆ ไปจนกว่าตัวนับจะรีเซ็ต

ด้านล่างนี้คือ 3 วิธีในการตั้งค่าองค์ประกอบ <Allow>

<Allow count="2000"/> 

<Allow countRef="verifyapikey.VerifyAPIKey.apiproduct.developer.quota.limit"/> 

<Allow count="2000" countRef="verifyapikey.VerifyAPIKey.apiproduct.developer.quota.limit"/> 

หากคุณระบุทั้ง count และ countRef countRef จะมีลำดับความสำคัญเหนือกว่า หาก countRef ไม่สามารถแก้ไขได้ในรันไทม์ ระบบจะใช้ค่าของ count

Attributes

องค์ประกอบ <Allow>/<Class>

องค์ประกอบ <Class> ช่วยให้คุณกำหนดค่าขององค์ประกอบ <Allow> ตามเงื่อนไขโดยอิงตามค่าของตัวแปรการไหลได้ นโยบายจะเก็บตัวนับที่แตกต่างกันสำหรับ<Allow>แท็กย่อยแต่ละรายการของ <Class>

หากต้องการใช้องค์ประกอบ <Class> ให้ระบุตัวแปรการไหลโดยใช้แอตทริบิวต์ ref กับแท็ก <Class> จากนั้น Edge จะใช้ค่าของตัวแปรโฟลว์เพื่อเลือกแท็กย่อย <Allow> รายการใดรายการหนึ่งเพื่อระบุจํานวนแท็กที่อนุญาตของนโยบาย Edge จะจับคู่ค่าของตัวแปรการไหลกับแอตทริบิวต์ class ของแอตทริบิวต์ <Allow> ดังที่แสดงด้านล่าง

<Allow>
  <Class ref="request.queryparam.time_variable">
    <Allow class="peak_time" count="5000"/>
    <Allow class="off_peak_time" count="1000"/>
  </Class>
</Allow>

ในตัวอย่างนี้ ตัวนับโควต้าปัจจุบันจะกำหนดโดยค่าของพารามิเตอร์การค้นหา time_variable ที่ส่งพร้อมกับคำขอแต่ละรายการ ตัวแปรดังกล่าวอาจมีค่าเป็น peak_time หรือ off_peak_time หากพารามิเตอร์การค้นหามีค่าที่ไม่ถูกต้อง นโยบายจะแสดงข้อผิดพลาดการละเมิดโควต้า

Attributes

องค์ประกอบ <Allow>/<Class>/<Allow>

องค์ประกอบ <Allow> ระบุขีดจํากัดสําหรับตัวนับโควต้าที่กําหนดโดยองค์ประกอบ <Class> นโยบายจะเก็บตัวนับที่แตกต่างกันสำหรับแท็กย่อย <Allow> แต่ละรายการของ <Class>

เช่น

<Allow>
  <Class ref="request.queryparam.time_variable">
    <Allow class="peak_time" count="5000"/>
    <Allow class="off_peak_time" count="1000"/>
  </Class>
</Allow>

ในตัวอย่างนี้ นโยบายโควต้าจะดูแลเคาน์เตอร์โควต้า 2 รายการที่มีชื่อว่า peak_time และ off_peak_time

Attributes

องค์ประกอบ <Interval>

ใช้เพื่อระบุจำนวนเต็ม (เช่น 1, 2, 5, 60 และอื่นๆ) ที่จะจับคู่กับ TimeUnit ที่คุณระบุ (นาที ชั่วโมง วัน สัปดาห์ หรือเดือน) เพื่อกำหนดระยะเวลาที่ Edge จะคำนวณการใช้โควต้า

เช่น Interval ของ 24 ที่มี TimeUnit ของ hour หมายความว่าระบบจะคำนวณโควต้าในช่วง 24 ชั่วโมง

<Interval ref="verifyapikey.VerifyAPIKey.apiproduct.developer.quota.interval">1</Interval>

Attributes

องค์ประกอบ <TimeUnit>

ใช้เพื่อระบุหน่วยเวลาที่ใช้กับโควต้า

เช่น Interval ของ 24 ที่มี TimeUnit ของ hour หมายความว่าระบบจะคำนวณโควต้าในช่วง 24 ชั่วโมง

<TimeUnit ref="verifyapikey.VerifyAPIKey.apiproduct.developer.quota.timeunit">month</TimeUnit>

Attributes

องค์ประกอบ <StartTime>

เมื่อตั้งค่า type เป็น calendar, จะระบุวันที่และเวลาที่ตัวนับโควต้าจะเริ่มนับ ไม่ว่าจะได้รับคําขอจากแอปใดก็ตาม

เช่น

<StartTime>2017-7-16 12:00:00</StartTime>

องค์ประกอบ <Distributed>

การติดตั้ง Edge สามารถใช้โปรแกรมประมวลผลข้อความอย่างน้อย 1 รายการเพื่อประมวลผลคำขอ ตั้งค่าองค์ประกอบนี้เป็น true เพื่อระบุว่านโยบายควรรักษาตัวนับส่วนกลางและซิงค์กับตัวประมวลผลข้อความทั้งหมดอย่างต่อเนื่อง โปรแกรมประมวลผลข้อความอาจอยู่ในโซนความพร้อมให้บริการและ/หรือภูมิภาคต่างๆ

หากคุณใช้ค่าเริ่มต้น false คุณอาจใช้โควต้าเกินเนื่องจากระบบจะไม่แชร์จํานวนสำหรับตัวประมวลผลข้อความแต่ละรายการ ดังนี้

<Distributed>true</Distributed>

หากต้องการให้ตัวนับมีการซิงค์และอัปเดตในคําขอทุกรายการ ให้ตั้งค่า <Distributed> และ <Synchronous> เป็น "จริง"

<Distributed>true</Distributed>
<Synchronous>true</Synchronous>

องค์ประกอบ <Synchronous>

ตั้งค่าเป็น true เพื่ออัปเดตตัวนับโควต้าแบบกระจายพร้อมกัน ซึ่งหมายความว่าการอัปเดตตัวนับจะดำเนินการพร้อมกันกับการตรวจสอบโควต้าในคำขอไปยัง API ตั้งค่าเป็น true หากไม่อนุญาตให้มีการเรียก API เกินโควต้า

ตั้งค่าเป็น false เพื่ออัปเดตตัวนับโควต้าแบบไม่พร้อมกัน ซึ่งหมายความว่าการเรียก API บางรายการที่เกินโควต้าอาจดำเนินการได้ ทั้งนี้ขึ้นอยู่กับเวลาที่ตัวนับโควต้าในที่เก็บข้อมูลส่วนกลางได้รับการอัปเดตแบบไม่พร้อมกัน อย่างไรก็ตาม คุณจะไม่ต้องเผชิญกับผลกระทบด้านประสิทธิภาพที่อาจเกิดขึ้นซึ่งเชื่อมโยงกับการอัปเดตแบบพร้อมกัน

ช่วงเวลาการอัปเดตแบบไม่พร้อมกันเริ่มต้นคือ 10 วินาที ใช้องค์ประกอบ AsynchronousConfiguration เพื่อกำหนดค่าลักษณะการทำงานแบบไม่สอดคล้องกันนี้

<Synchronous>false</Synchronous>

องค์ประกอบ <AsynchronousConfiguration>

กําหนดค่าช่วงเวลาการซิงค์ระหว่างตัวนับโควต้าแบบกระจายเมื่อองค์ประกอบการกําหนดค่านโยบาย <Synchronous> ไม่อยู่หรือไม่อยู่และตั้งค่าเป็น false

คุณสามารถซิงค์หลังจากระยะเวลาหนึ่งหรือจำนวนข้อความโดยใช้องค์ประกอบย่อย SyncIntervalInSeconds หรือ SyncMessageCount ข้อมูลเหล่านี้จะแยกกันโดยสิ้นเชิง ตัวอย่างเช่น

<AsynchronousConfiguration>
   <SyncIntervalInSeconds>20</SyncIntervalInSeconds>
</AsynchronousConfiguration>

หรือ

<AsynchronousConfiguration>
   <SyncMessageCount>5</SyncMessageCount>
</AsynchronousConfiguration>

องค์ประกอบ <AsynchronousConfiguration>/<SyncIntervalInSeconds>

ใช้เพื่อลบล้างลักษณะการทำงานเริ่มต้นซึ่งจะทำการอัปเดตแบบไม่พร้อมกันหลังจากผ่านไป 10 วินาที

<AsynchronousConfiguration>
   <SyncIntervalInSeconds>20</SyncIntervalInSeconds>
</AsynchronousConfiguration>

ช่วงเวลาการซิงค์ต้องมากกว่าหรือเท่ากับ 10 วินาทีตามที่อธิบายไว้ในหัวข้อขีดจํากัด

<AsynchronousConfiguration>/<SyncMessageCount> element

ระบุจํานวนคําขอในโปรแกรมประมวลผลข้อความ Apigee ทั้งหมดระหว่างการอัปเดตโควต้า

<AsynchronousConfiguration>
   <SyncMessageCount>5</SyncMessageCount>
</AsynchronousConfiguration>

ตัวอย่างนี้ระบุว่าระบบจะอัปเดตจำนวนโควต้าทุกๆ 5 คำขอในเครื่องประมวลผลข้อความ Apigee Edge แต่ละเครื่อง

องค์ประกอบ <Identifier>

ใช้องค์ประกอบ <Identifier> เพื่อกําหนดค่านโยบายเพื่อสร้างตัวนับที่ไม่ซ้ำกันตามตัวแปรการไหล

หากคุณไม่ได้ใช้องค์ประกอบนี้ นโยบายจะใช้ตัวนับเดียวกับโควต้า

องค์ประกอบนี้ยังกล่าวถึงในโพสต์ชุมชน Apigee ต่อไปนี้ด้วย http://community.apigee.com/questions/2807/how-does-the-edge-quota-policy-work-when-no-identi.html

<Identifier ref="verifyapikey.verify-api-key.client_id"/>

Attributes

องค์ประกอบ <MessageWeight>

ใช้เพื่อระบุน้ำหนักที่กำหนดให้กับข้อความแต่ละรายการ ใช้น้ำหนักข้อความเพื่อเพิ่มผลลัพธ์ของข้อความคำขอ เช่น ข้อความที่ต้องใช้ทรัพยากรการประมวลผลมากกว่าข้อความอื่นๆ

เช่น คุณต้องการนับข้อความ POST ว่า "หนัก" หรือมีค่าใช้จ่ายมากกว่าข้อความ GET 2 เท่า ดังนั้น คุณจึงตั้งค่า MessageWeight เป็น 2 สําหรับ POST และ 1 สําหรับ GET คุณยังตั้งค่า MessageWeight เป็น 0 ได้ด้วยเพื่อให้คำขอไม่ส่งผลต่อตัวนับ ในตัวอย่างนี้ หากโควต้าคือ 10 ข้อความต่อนาที และ MessageWeight สำหรับคำขอ POST คือ 2 โควต้าจะอนุญาตคำขอ POST 5 รายการในระยะ 10 นาที ระบบจะปฏิเสธคำขอเพิ่มเติม ไม่ว่าจะเป็น POST หรือ GET ก่อนที่จะรีเซ็ตตัวนับ

ค่าที่แสดงถึง MessageWeight ต้องระบุโดยตัวแปรการไหล และสามารถดึงมาจากส่วนหัว HTTP, พารามิเตอร์การค้นหา, เพย์โหลดคําขอ XML หรือ JSON หรือตัวแปรการไหลอื่นๆ เช่น คุณตั้งค่าในส่วนหัวชื่อ weight

<MessageWeight ref="message_weight"/>

ตัวแปรของโฟลว์

ระบบจะป้อนค่าตัวแปร Flow ที่กําหนดไว้ล่วงหน้าต่อไปนี้โดยอัตโนมัติเมื่อนโยบายโควต้าทํางาน ดูข้อมูลเพิ่มเติมเกี่ยวกับตัวแปรของ Flow ได้ที่ข้อมูลอ้างอิงตัวแปร

ข้อมูลอ้างอิงข้อผิดพลาด

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Deployment errors

Fault variables

These variables are set when this policy triggers an error. For more information, see What you need to know about policy errors.

Example error response

{  
   "fault":{  
      "detail":{  
         "errorcode":"policies.ratelimit.QuotaViolation"
      },
      "faultstring":"Rate limit quota violation. Quota limit  exceeded. Identifier : _default"
   }
}

Example fault rule

<FaultRules>
    <FaultRule name="Quota Errors">
        <Step>
            <Name>JavaScript-1</Name>
            <Condition>(fault.name Matches "QuotaViolation") </Condition>
        </Step>
        <Condition>ratelimit.Quota-1.failed=true</Condition>
    </FaultRule>
</FaultRules>

สคีมา

หัวข้อที่เกี่ยวข้อง

นโยบาย ResetQuota

SpikeArrest policy

การเปรียบเทียบนโยบายโควต้า การหยุดการเพิ่มขึ้นอย่างฉับพลัน และขีดจำกัดอัตราพร้อมกัน