Kota politikası

Apigee Edge belgelerini görüntülüyorsunuz.
. Git: Apigee X belgeleri. bilgi

Ne?

Bir API proxy'sinin izin verdiği istek mesajı sayısını yapılandırmak için Kota politikasını kullanın. Dakika, saat, gün, hafta veya ay gibi bir zaman dilimi. Kotayı şu değere göre ayarlayabilirsiniz: API proxy'sine erişen tüm uygulamalar için aynıdır veya kotayı aşağıdakilere göre ayarlayabilirsiniz:

• API proxy'sini içeren ürün
• API isteyen uygulama
• Uygulama geliştirici
• Başka birçok kriter

Genel trafik artışlarına karşı kendinizi korumak için Kota'yı kullanmayın. Bunun için Spike Arrest'i kullanın. politikası. Bkz. Spike Arrest politikasına tabidir.

Videolar

Bu videolar, Kota politikasıyla kota yönetimini tanıtır:

Örnekler

Bu politika kodu örnekleri, kota dönemlerinin nasıl başlatılacağını ve biteceğini aşağıdaki şekilde gösterir:

<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>

Kota politikası hakkında

Kota, bir API proxy'sinin belirli bir dönemde işleyebileceği istek mesajlarının servis birimidir. Örneğin dakika, saat, gün, hafta veya ay. Politika, her sayfada gösterilen API proxy'si tarafından alınan istek sayısı. Bu olanak, API sağlayıcılarının uygulamaların belirli bir zaman aralığında yaptığı API çağrılarının sayısı. Kota politikalarını kullanarak Örneğin, uygulamaları dakikada 1 istek veya ayda 10.000 istek ile sınırlandırabilirsiniz.

Örneğin, bir Kota ayda 10.000 ileti olarak tanımlanırsa hız sınırı şu tarihten sonra başlar: mesajı görebilirsiniz. İlk oturumda 10.000 iletinin sayılıp sayılmadığı veya günü veya o dönemin son günü; Kota sayacına kadar ek istek alanına izin verilmez belirtilen zaman aralığının sonunda veya Kota açıkça belirlenene kadar Kotayı Sıfırla aracını kullanarak sıfırlama politikasına tabidir.

SpikeArrest adlı Kota’da yapılan bir varyasyon, gerçekleşebilecek trafikteki ani artışları (veya patlamaları) kullanımdaki ani artıştan, hatalı istemcilerden veya kötü amaçlı saldırılardan kaynaklanabilir. Daha fazla SpikeArrest hakkında daha fazla bilgi için Spike Arrest politikasını inceleyin.

Kotalar, bağımsız API proxy'leri için geçerlidir ve API proxy'leri arasında dağıtılmaz. Örneğin, Bir API ürününde üç API proxy'si varsa bunların üçünde de tek bir kota paylaşılmaz kota politikası yapılandırmasını da kullanabilir.

Kota politikası türleri

Kota politikası birkaç farklı politika türünü destekler: varsayılan, calendar, flexi ve rollingwindow. Her tür, kota sayacının ne zaman aşağıdaki tabloda gösterildiği gibi, sıfırlandığı zaman başlatılır:

type="calendar" için <StartTime>.

Tabloda, rollingwindow türü için değer listelenmez. Kayar pencere kotalar, bir saat veya bir günlük zaman aralığı gibi bir kota "penceresi" boyutu ayarlanarak çalışır. Bir yeni istek geldiğinde politika, kotanın geçmişte aşılıp aşılmadığını belirler "pencere" kazanıyor.

Örneğin, 1.000 isteğe izin veren iki saatlik bir aralık tanımlarsınız. Yeni bir istek saat 16:45'te alınır.Politika, son iki saatlik zaman dilimi için kota sayısını hesaplar yani 14:45'ten beri gelen istek sayısıdır. Bu süre içinde kota sınırı aşılmamışsa iki saatlik bir süre içinde, isteğe izin verilir.

Bir dakika sonra, 16:46'da başka bir istek geliyor. Artık politika, 14:46'dan bu yana uygulanan kota sayısı.

rollingwindow türü için sayaç hiçbir zaman sıfırlanmaz, ancak yeniden hesaplanır.

Kota sayaçlarını anlama

Kota politikası, varsayılan olarak tek bir sayacı korur. API proxy'sinde referansta bulunmamalıdır. Kota sayacının adı şu tarihe göre belirlenir: politikanın name özelliği.

Örneğin, sınırı 5 olan MyQuotaPolicy adlı bir Kota politikası oluşturuyorsunuz. ve API proxy'sinde birden fazla akışa (Akış A, B ve C) yerleştirebilir. Her ne kadar birden çok akışta kullanılıyorsa, öğenin tüm örnekleri tarafından güncellenen tek bir sayaç sağlar. politika:

• A Akışı yürütüldü -> MyQuotaPolicy çalıştırıldı ve sayacı = 1
• B Akışı yürütüldü -> MyQuotaPolicy çalıştırıldı ve sayacı = 2
• A Akışı yürütüldü -> MyQuotaPolicy çalıştırıldı ve sayacı = 3 olarak ayarlandı
• C Akışı yürütüldü -> MyQuotaPolicy çalıştırıldı ve sayacı = 4
• A Akışı yürütüldü -> MyQuotaPolicy çalıştırıldı ve sayacı = 5.

Kota sayacı kota sayacına ulaştığından, üç akıştan herhangi birine yönelik sonraki istek reddedildi izin vermez.

API proxy akışında birden fazla yerde aynı Kota politikasını kullanma, kotanın beklediğinizden hızlı tükenmesine neden olmamasına neden olabilir. Bu durum, The Book of Apigee Edge Antipatterns (Apigee Edge Antipatterns Kitabı).

Alternatif olarak, API proxy'nizde birden fazla Kota politikası tanımlayabilir ve farklı bir Kota politikası kullanabilirsiniz her bir akışta takip edin. Her Kota politikası, politikanın name özelliği.

Alternatif olarak Şurada <Class> veya <Identifier> öğe: Kota politikasını kullanın. Bu araçları kullanarak öğeleri varsa tek bir politika, istekte bulunan uygulamaya bağlı olarak farklı sayaçlar sağlayabilir. istekte bulunan uygulama geliştirici, istemci kimliği veya başka bir istemci tanımlayıcısı vb. Bkz. daha fazla bilgi için yukarıdaki örneklere <Class> veya <Identifier> öğeleri.

Saat gösterimi

Tüm Kota süreleri Eşgüdümlü Evrensel Saat (UTC) saat dilimi.

Kota saati gösterimi, Uluslararası standartlarda tanımlanan uluslararası standart tarih gösterimini izler Standart ISO 8601.

Tarihler yıl, ay ve gün olarak tanımlanır ve şu biçimde belirtilir: YYYY-MM-DD. Örneğin, 2015-02-04 4 Şubat 2015'i temsil eder.

Günün saati, aşağıdaki biçimde saat, dakika ve saniye olarak tanımlanır: hours:minutes:seconds Örneğin, 23:59:59, zaman dilimini temsil eder gece yarısından önce ikinci saniye.

00:00:00 ve 24:00:00 gösterimini kullanabileceğinizi unutmayın. bir tarihle ilişkilendirilebilecek iki gece yarısını birbirinden ayırt eder. Bu nedenle 2015-02-04 24:00:00, 2015-02-05 00:00:00 ile aynı tarih ve saattir. İkincisi ise genellikle tercih edilen gösterimdir.

API ürün yapılandırmasından kota ayarlarını alma

API ürün yapılandırmalarında kota sınırları belirleyebilirsiniz. Bu sınırlar otomatik olarak kotayı zorunlu kıl. Bunun yerine, bir kota politikasındaki ürün kotası ayarlarına başvurabilirsiniz. Aşağıda bazı örnekler verilmiştir: kota politikalarının referans olarak alması için ürün için bir kota ayarlamanın avantajları:

• Kota politikaları, API ürünündeki tüm API proxy'leri için tek tip bir ayar kullanabilir.
• Bir API ürününün kota ayarı ve kota politikaları üzerinde çalışma zamanında değişiklik yapabilirsiniz. kota değerleri otomatik olarak güncellenmiştir.

Bir API ürününden kota ayarlarını kullanma hakkında daha fazla bilgi için "Dinamik Kota" bölümüne bakın başlıklı bölüme bakın..

API ürünlerini kota sınırlarıyla yapılandırma hakkında bilgi edinmek için API ürünleri oluşturma başlıklı makaleyi inceleyin.

Öğe referansı

Bu politikada yapılandırabileceğiniz öğeler ve özellikler aşağıda verilmiştir. Bazı öğelerin birlikte kullanılması gerekmez veya gerekli değildir. Özel kullanım örneklerine göz atın. İlgili içeriği oluşturmak için kullanılan Aşağıdaki verifyapikey.VerifyAPIKey.apiproduct.* değişken aşağıdaki durumlarda varsayılan olarak kullanılabilir: "VerifyAPIKey" adlı bir API Anahtarı Doğrulama politikası , istekteki uygulamanın API anahtarını kontrol etmek için kullanılır. Değişken değerleri, anahtarın ilişkilendirildiği API ürünündeki kota ayarlarından gelir API ürününden kota ayarlarını alma konusunda açıklandığı gibi yapılandırma hakkında daha fazla bilgi edinin.

<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> özellikler

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

Aşağıdaki özellikler bu politikaya özeldir.

Aşağıdaki tabloda tüm politika üst öğelerinde ortak olan özellikler açıklanmaktadır:

<DisplayName> öğe

Politikayı name özelliğine ek olarak farklı bir doğal dil adına sahip yönetim arayüzü proxy düzenleyicisi.

<DisplayName>Policy Display Name</DisplayName>

<Allow> öğe

Kotanın sayı sınırını belirtir. Politikanın sayacı bu sınıra ulaşırsa değerinde olması gerekir. Sayaç sıfırlanana kadar sonraki çağrılar reddedilir.

Aşağıda, <Allow> öğesini ayarlamanın üç yolu gösterilmektedir:

<Allow count="2000"/> 

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

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

Hem count hem de countRef öğesini belirtirseniz countRef öncelik kazanır. countRef çalışma zamanında çözümlenmezse count kullanılıyor.

Özellikler

<Allow>/<Class> öğe

<Class> öğesi, değeri koşullandırmanıza olanak tanır bir akış değişkeninin değerine göre <Allow> öğesinin değerini belirleyin. Örneğin, <Class> öğesinin her farklı <Allow> alt etiketi, politikada farklı bir karşı bildirim kullanılır.

<Class> öğesini kullanmak için <Class> etiketine ref özelliği. Edge, daha sonra akış değişkeni kullanarak <Allow> alt etiketten birini seçerek politika sayısı. Edge, akış değişkeninin değerini class ile eşleştirir özelliğinin <Allow> özelliğine ilişkin aşağıdaki gibidir:

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

Bu örnekte, mevcut kota sayacı Her istekle birlikte time_variable sorgu parametresi iletildi. Bu değişkenin bir değeri olabilir peak_time veya off_peak_time. Sorgu parametresi geçersiz bir değerine ayarlanırsa politika bir kota ihlali hatası döndürür.

Özellikler

<Allow>/<Class>/<Allow> öğe

<Allow> öğesi, kota sayacı sınırını belirtir <Class> öğesi ile tanımlanır. Her bir <Class> öğesinin farklı <Allow> alt etiketi, politikası farklı bir karşıtlığa sahiptir.

Örneğin:

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

Bu örnekte, Kota politikası peak_time ve off_peak_time.

Özellikler

<Interval> öğe

Saat belirlemek için belirttiğiniz TimeUnit (dakika, saat, gün, hafta veya ay) Edge'in kota kullanımını hesapladığı süre.

Örneğin, 24 içeren Interval hour TimeUnit değeri, kotanın toplam 24 saat içinde hesaplanır.

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

Özellikler

<TimeUnit> öğe

Kota için geçerli olan zaman birimini belirtmek üzere kullanın.

Örneğin, 24 içeren Interval hour TimeUnit değeri, kotanın toplam 24 saat içinde hesaplanır.

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

Özellikler

<StartTime> öğe

type, calendar, olarak ayarlandığında tarihi belirtir tüm isteklerin bu hatadan kaynaklanmış olup olmadığına bakılmaksızın, kota sayacının (herhangi bir uygulamadan alınan)

type açıkça ayarlandığında açık bir StartTime sağlamanız gerekir calendar, için bir akış değişkenine referans kullanamazsınız. type değeri ayarlanmadığında StartTime değeri için hatası.

Örneğin:

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

<Dağıtıldı> öğe

Edge kurulumunda istekleri işlemek için bir veya daha fazla Mesaj İşleyici kullanılabilir. Bunu ayarla öğesini true öğesine göndererek politikanın merkezi bir tüm İleti İşlemcileri arasında sürekli olarak senkronize eder. Mesaj işleyiciler kullanılabilirlik alt bölgeleri ve/veya bölgeler arasında olabilir.

Varsayılan false değerini kullanırsanız kotanızı aşabilirsiniz: Her İleti İşleyen için sayı paylaşılmaz:

<Distributed>true</Distributed>

Sayaçların senkronize edilmesini ve her istekte güncellenmesini sağlamak için <Distributed> ve <Synchronous> değerleri doğru değerine ayarlandı:

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

&lt;Synchronous&gt; öğe

Dağıtılmış bir kota sayacını eşzamanlı olarak güncellemek için true olarak ayarlayın. Bu Sayaçta yapılan güncellemenin, bir istekte kota kontrol edildiği anda yapıldığı anlamına gelir. bağlantı kurmalısınız. Hiçbir API'ye izin vermemeniz gerekiyorsa true olarak ayarlayın çağrısından yararlanır.

Kota sayacını eşzamansız olarak güncellemek için false olarak ayarlayın. Bunun anlamı şudur: ne zaman yapılacağına bağlı olarak, kotayı aşan bazı API çağrılarının merkezi depodaki kota sayacı eşzamansız olarak güncellenir. Ancak, eşzamanlı güncellemelerin performans üzerindeki olası etkilerini görebilirsiniz.

Varsayılan eşzamansız güncelleme aralığı 10 saniyedir. Şunu kullanın: AsynchronousConfiguration öğesini kullanın.

<Synchronous>false</Synchronous>

&lt;AsynchronousConfiguration&gt; öğe

Politika şu durumlarda dağıtılmış kota sayaçları arasındaki senkronizasyon aralığını yapılandırır. <Synchronous> yapılandırma öğesi mevcut değil veya mevcut ve ayarlanmış Hedef: false.

Verileri bir süre geçtikten sonra veya ileti sayısı metriğinden sonra senkronize etmek için SyncIntervalInSeconds veya SyncMessageCount alt öğeleri. Birbirinden bağımsızdırlar. Örneğin,

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

veya

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

&lt;AsynchronousConfiguration&gt;/&lt;SyncIntervalInSeconds&gt; öğe

Eşzamansız güncellemelerin olduğunu varsayalım.

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

Senkronizasyon aralığı şurada açıklandığı gibi en az 10 saniye olmalıdır: Sınırlar konusu.

&lt;AsynchronousConfiguration&gt;/&lt;SyncMessageCount&gt; öğe

Tüm Apigee mesaj işlemcilerindeki kotalar arasında gönderilen istek sayısını belirtir güncellemelerine göz atın.

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

Bu örnek, kota sayısının her Apigee'de 5 istekte bir güncellendiğini belirtir. Uç mesaj işlemcisi.

&lt;Identifier&gt; öğe

Benzersiz reklam öğeleri oluşturmak üzere politikayı yapılandırmak için <Identifier> öğesini kullanın. bir akış değişkenine dayalı sayaçlar.

Bu öğeyi kullanmazsanız politika, kota.

Bu unsura aşağıdaki Apigee Topluluk gönderisinde de değinilmektedir: 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"/>

Özellikler

&lt;MessageWeight&gt; öğe

Her bir iletiye atanan ağırlığı belirtmek için kullanın. Mesaj ağırlığını kullanarak (örneğin, diğerlerine göre daha fazla işlem kaynağı tüketen iletiler) isteme.

Örneğin, POST iletilerinin "ağır" ileti olarak iki kat daha fazla sayılmasını istiyorsunuz. pahalıya mal olabilir. mesaj. Bu nedenle, bir POST için MessageWeight değerini 2, İNDİRİN. MessageWeight değerini 0 olarak bile ayarlayabilirsiniz. Böylece, istekte sayacı etkiler. Bu örnekte, kota dakikada 10 ileti ise ve POST istekleri için MessageWeight değeri 2 ise kota Herhangi bir 10 dakikalık aralıkta 5 POST isteğine izin verir. Ek istek (POST veya GET) geri dönmesini sağlar.

MessageWeight öğesini temsil eden bir değer, bir akışta belirtilmelidir. değişkenidir ve HTTP üstbilgilerinden, sorgu parametrelerinden, bir XML veya JSON isteğinden akış değişkeni olabilir. Örneğin, bunu weight:

<MessageWeight ref="message_weight"/>

Akış değişkenleri

Aşağıdaki önceden tanımlanmış Akış değişkenleri, Kota politikası kullanıldığında otomatik olarak doldurulur yürütülür. Akış değişkenleri hakkında daha fazla bilgi için Değişkenler referansı bölümüne bakın.

Hata referansı

Bu bölümde, bu politika bir hatayı tetiklediğinde döndürülen hata kodları ve hata mesajlarının yanı sıra Edge tarafından ayarlanan hata değişkenleri açıklanmaktadır. Hata kuralları geliştirirken bu bilgilerin farkında olmanız önemlidir. hoşuma gitmesi için bir fırsattır. Daha fazla bilgi için Bilmeniz gerekenler Politika hataları ve Kullanım sorun.

Çalışma zamanı hataları

Bu hatalar, politika yürütüldüğünde ortaya çıkabilir.

Dağıtım hataları

Hata değişkenleri

Bu değişkenler, politika bir hatayı tetiklediğinde ayarlanır. Daha fazla bilgi için Bilmeniz gerekenler hakkında daha fazla bilgi edinin.

Örnek hata yanıtı

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

Örnek hata kuralı

<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>

Şemalar

İlgili konular

ResetQuota politikası

SpikeArrest politika

Karşılaştırma Kota, Ani Artışı ve Eşzamanlı Hız Sınırlaması Politikaları