Kota politikası

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. info

Ne?

Kota politikasını kullanarak bir API proxy'sinin belirli bir süre (ör. dakika, saat, gün, hafta veya ay) boyunca izin verdiği istek mesajlarının sayısını yapılandırın. Kotayı, API proxy'sine erişen tüm uygulamalar için aynı olacak şekilde ayarlayabilir veya kotayı şu ölçütlere göre belirleyebilirsiniz:

• API proxy'sini içeren ürün
• API'yi isteyen uygulama
• Uygulama geliştirici
• Diğer birçok ölçüt

Genel trafik artışlarına karşı koruma sağlamak için kotayı kullanmayın. Bunun için Spike Arrest politikasını kullanın. Spike Arrest politikasını inceleyin.

Videolar

Bu videolarda, kota politikasıyla kota yönetimi tanıtılmaktadır:

Örnekler

Bu politika kodu örnekleri, kota dönemlerinin nasıl başlatılıp sonlandırılacağını 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 süre (ör. dakika, saat, gün, hafta veya ay) içinde işleyebileceği istek mesajlarının ayrılmış kısmıdır. Politika, API proxy'si tarafından alınan isteklerin sayısını gösteren sayaçları tutar. Bu özellik, API sağlayıcıların belirli bir süre içinde uygulamalar tarafından yapılan API çağrılarının sayısına sınır uygulamasına olanak tanır. Kota politikalarını kullanarak örneğin uygulamaları dakikada 1 istekle veya ayda 10.000 istekle sınırlayabilirsiniz.

Örneğin, kota ayda 10.000 ileti olarak tanımlanmışsa hız sınırlama, 10.000. iletiden sonra başlar. Bu dönemde ilk gün mü yoksa son gün mü 10.000 mesaj sayıldığı önemli değildir. Belirtilen zaman aralığının sonunda kota sayacı otomatik olarak sıfırlanana veya Kotayı Sıfırla politikası kullanılarak kota açıkça sıfırlanana kadar ek istek gönderilemez.

Kota'nın bir varyasyonu olan SpikeArrest, kullanımda ani artış, hatalı istemciler veya kötü amaçlı saldırılar nedeniyle oluşabilecek trafik artışlarını (veya patlamalarını) önler. SpikeArrest hakkında daha fazla bilgi için Spike Arrest politikası konusuna bakın.

Kotalar, tek tek 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'niz varsa üçü de aynı kota politikası yapılandırmasını kullansa bile üçü arasında tek bir kota paylaşılmaz.

Kota politikası türleri

Kota politikası; varsayılan, calendar, flexi ve rollingwindow olmak üzere çeşitli politika türlerini destekler. Her tür, aşağıdaki tabloda gösterildiği gibi kota sayacının ne zaman başlayacağını ve ne zaman sıfırlanacağını tanımlar:

type="calendar" için <StartTime> değerini belirtmeniz gerekir.

Tabloda rollingwindow türü için değer listelenmiyor. Hareketli pencere kotaları, bir saatlik veya bir günlük pencere gibi bir kota "penceresinin" boyutunu ayarlayarak çalışır. Yeni bir istek geldiğinde politika, geçmişteki "zaman aralığında" kotanın aşılıp aşılmadığını belirler.

Örneğin, 1.000 isteğe izin veren iki saatlik bir pencere tanımladığınızı varsayalım. Saat 16:45'te yeni bir istek gelir. Politika, son iki saatlik pencerenin kota sayısını hesaplar. Bu, saat 14:45'ten itibaren gelen isteklerin sayısı anlamına gelir. İki saatlik süre içinde kota sınırı aşılmamışsa isteğe izin verilir.

Bir dakika sonra, saat 16:46'da başka bir istek gelir. Artık politika, sınırın aşılıp aşılmadığını belirlemek için saat 14:46'dan itibaren kota sayısını hesaplıyor.

rollingwindow türünde sayaç hiçbir zaman sıfırlanmaz ancak her istekte yeniden hesaplanır.

Kota sayaçlarını anlama

Varsayılan olarak, bir kota politikası, API proxy'sinde kaç kez referans verdiğinizden bağımsız olarak tek bir sayaç tutar. Kota sayacının adı, politikanın name özelliğine göre belirlenir.

Örneğin, 5 istek sınırı olan MyQuotaPolicy adlı bir kota politikası oluşturup bunu API proxy'sindeki birden fazla akışa (A, B ve C akışları) yerleştirirsiniz. Birden fazla akışta kullanılsa da politikanın tüm örnekleri tarafından güncellenen tek bir sayaç tutar:

• A akışı yürütülür -> MyQuotaPolicy yürütülür ve sayacı = 1 olur.
• B akışı yürütülür -> MyQuotaPolicy yürütülür ve sayacı = 2 olur.
• A akışı yürütülür -> MyQuotaPolicy yürütülür ve sayacı = 3 olur.
• C akışı yürütülür -> MyQuotaPolicy yürütülür ve sayaç değeri 4 olur.
• A akışı yürütülür -> MyQuotaPolicy yürütülür ve sayaç değeri 5 olur.

Kota sayacı sınırına ulaştığı için üç akıştan herhangi birine yapılan sonraki istek reddedilir.

Bir API proxy akışında aynı kota politikasını birden fazla yerde kullanmak, kotanın beklenenden daha hızlı tükenmesine neden olabileceğinden The Book of Apigee Edge Antipatterns'te açıklanan bir anti-pattern'dir.

Alternatif olarak, API proxy'nizde birden fazla kota politikası tanımlayabilir ve her akışta farklı bir politika kullanabilirsiniz. Her kota politikası, politikanın name özelliğine göre kendi sayacını tutar.

Alternatif olarak, tek bir politikada birden fazla benzersiz sayaç tanımlamak için kota politikasındaki <Class> veya <Identifier> öğelerini kullanın. Bu öğeler kullanılarak, isteği gönderen uygulamaya, isteği gönderen uygulama geliştiriciye, istemci kimliğine veya diğer istemci tanımlayıcılara göre tek bir politikada farklı sayaçlar tutulabilir. <Class> veya <Identifier> öğelerini kullanma hakkında daha fazla bilgi için yukarıdaki örneklere bakın.

Zaman gösterimi

Tüm kota zamanları Eşgüdümlü Evrensel Saat (UTC) saat dilimine ayarlanır.

Kota zamanı gösterimi, Uluslararası Standart ISO 8601'de tanımlanan uluslararası standart tarih gösterimine uygundur.

Tarihler, yıl, ay ve gün olarak aşağıdaki biçimde tanımlanır: 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, gece yarısından bir saniye önceki zamanı gösterir.

Bir tarihle ilişkilendirilebilecek iki gece yarısını ayırt etmek için 00:00:00 ve 24:00:00 olmak üzere iki gösterim kullanılabileceğini unutmayın. Bu nedenle 2015-02-04 24:00:00, 2015-02-05 00:00:00 ile aynı tarih ve saattir. Genellikle ikinci gösterim tercih edilir.

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, kotayı otomatik olarak zorunlu kılmaz. Bunun yerine, kota politikasında ürün kotası ayarlarına referans verebilirsiniz. Kota politikalarının referans alması için ürüne kota belirlemenin bazı avantajları şunlardır:

• Kota politikaları, API ürünündeki tüm API proxy'lerinde tek bir ayar kullanabilir.
• Bir API ürünündeki kota ayarında çalışma zamanı değişiklikleri yapabilirsiniz. Değere referans veren kota politikaları, kota değerlerini otomatik olarak günceller.

Kota ayarlarını bir API ürününden kullanma hakkında daha fazla bilgi için yukarıdaki "Dinamik Kota" örneğine bakın..

Kota sınırları olan API ürünlerini yapılandırma hakkında bilgi 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ı öğe kombinasyonlarının birbirini dışladığını veya gerekli olmadığını unutmayın. Belirli kullanımlar için örneklere bakın. İsteklerde uygulamanın API anahtarını kontrol etmek için "VerifyAPIKey" adlı bir API anahtarını doğrulama politikası kullanıldığında aşağıdaki verifyapikey.VerifyAPIKey.apiproduct.* değişkenleri varsayılan olarak kullanılabilir. Değişken değerleri, anahtarın ilişkili olduğu API ürünündeki kota ayarlarından gelir. Bu durum, API ürünü yapılandırmasından kota ayarlarını alma bölümünde açıklanmıştır.

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

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

&lt;DisplayName&gt; öğ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> öğesi

Kotanın sayı sınırını belirtir. Politikanın sayacı bu sınır değerine ulaşırsa 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 öncelikli olur. countRef çalışma zamanında çözümlenmezse count değeri kullanılır.

Özellikler

<Allow>/<Class> öğesi

<Class> öğesi, <Allow> öğesinin değerini bir akış değişkeninin değerine göre koşullandırmanıza olanak tanır. Politika, <Class> öğesinin her farklı <Allow> alt etiketi için farklı bir sayaç tutar.

<Class> öğesini kullanmak için <Class> etiketine ref özelliğini kullanarak bir akış değişkeni belirtin. Ardından Edge, izin verilen politika sayısını belirlemek için <Allow> alt etiketlerinden birini seçmek üzere akış değişkeninin değerini kullanır. Edge, akış değişkeninin değerini aşağıdaki örnekte gösterildiği gibi <Allow> etiketinin class özelliğiyle eşleştirir:

<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 iletilen time_variable sorgu parametresinin değeriyle belirlenir. Bu değişkenin değeri peak_time veya off_peak_time olabilir. Sorgu parametresi geçersiz bir değer içeriyorsa politika, kota ihlali hatası döndürür.

Özellikler

<Allow>/<Class>/<Allow> öğesi

<Allow> öğesi, <Class> öğesi tarafından tanımlanan bir kota sayacı için sınırı belirtir. Politika, <Class> öğesinin her farklı <Allow> alt etiketi için farklı bir sayaç tutar.

Ö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 adlı iki kota sayacı tutar.

Özellikler

<Interval> öğesi

Edge'in kota kullanımını hesaplayacağı bir zaman aralığını belirlemek için, belirttiğiniz TimeUnit (dakika, saat, gün, hafta veya ay) ile eşleştirilecek bir tam sayı (ör. 1, 2, 5, 60 vb.) belirtmek için kullanılır.

Örneğin, Interval 24 ile TimeUnit hour, kotanın 24 saat içinde hesaplanacağı anlamına gelir.

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

Özellikler

<TimeUnit> öğesi

Kotanın geçerli olduğu zaman birimini belirtmek için kullanılır.

Örneğin, Interval 24 ile TimeUnit hour, kotanın 24 saat içinde hesaplanacağı anlamına gelir.

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

Özellikler

<StartTime> öğesi

type, calendar, olarak ayarlandığında, herhangi bir uygulamadan istek alınıp alınmadığına bakılmaksızın kota sayacının saymaya başlayacağı tarih ve saati belirtir.

Örneğin:

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

<Distributed> öğesi

Edge'in bir yüklemesi, istekleri işlemek için bir veya daha fazla Mesaj İşleyici kullanabilir. Politikanın merkezi bir sayaç tutması ve bunu tüm Mesaj İşleyiciler arasında sürekli olarak senkronize etmesi gerektiğini belirtmek için bu öğeyi true olarak ayarlayın. Mesaj işlemciler, kullanılabilirlik alanları ve/veya bölgeler arasında olabilir.

false varsayılan değerini kullanırsanız her Mesaj İşleyici'nin sayısı paylaşılmadığı için kotanızı aşabilirsiniz:

<Distributed>true</Distributed>

Sayaçların senkronize edildiğinden ve her istekte güncellendiğinden emin olmak için <Distributed> ve <Synchronous> değerlerini true olarak ayarlayın:

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

<Synchronous> öğesi

Dağıtılmış kota sayacını eşzamanlı olarak güncellemek için true olarak ayarlayın. Bu, sayaç güncellemesinin, API'ye yapılan bir istekte kota kontrolüyle aynı anda yapıldığı anlamına gelir. Kota üzerinde API çağrılarına izin vermemeniz gerekiyorsa true olarak ayarlayın.

Kota sayacını eşzamansız olarak güncellemek için false olarak ayarlayın. Bu, merkezi depodaki kota sayacı eşzamansız olarak güncellendiğinden, kotayı aşan bazı API çağrılarının geçebileceği anlamına gelir. Ancak, eşzamanlı güncellemelerle ilişkili olası performans etkileriyle karşılaşmazsınız.

Varsayılan eşzamansız güncelleme aralığı 10 saniyedir. Bu eşzamansız davranışı yapılandırmak için AsynchronousConfiguration öğesini kullanın.

<Synchronous>false</Synchronous>

<AsynchronousConfiguration> öğesi

Politika yapılandırma öğesi <Synchronous> mevcut değilse veya mevcutsa ve false olarak ayarlanmışsa dağıtılmış kota sayaçları arasındaki senkronizasyon aralığını yapılandırır.

SyncIntervalInSeconds veya SyncMessageCount alt öğelerini kullanarak belirli bir süre sonra ya da belirli sayıda mesajdan sonra senkronize edebilirsiniz. Bu iki özellik birlikte kullanılamaz. Örneğin,

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

veya

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

<AsynchronousConfiguration>/<SyncIntervalInSeconds> öğesi

Bu ayarı, varsayılan davranış olan 10 saniyelik aralıklarla yapılan eşzamansız güncellemeleri geçersiz kılmak için kullanın.

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

Senkronizasyon aralığı, Sınırlar başlıklı makalede açıklandığı gibi en az 10 saniye olmalıdır.

<AsynchronousConfiguration>/<SyncMessageCount> öğesi

Kota güncellemeleri arasında tüm Apigee mesaj işlemcilerindeki istek sayısını belirtir.

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

Bu örnek, kota sayısının her Apigee Edge mesaj işleyicisinde 5 istekte bir güncellendiğini belirtir.

<Identifier> öğesi

Politikayı, bir akış değişkenine göre benzersiz sayaçlar oluşturacak şekilde yapılandırmak için <Identifier> öğesini kullanın.

Bu öğeyi kullanmazsanız politika, kotaya uygulanan tek bir sayaç kullanır.

Bu öğe, aşağıdaki Apigee Topluluğu yayınında da ele alınmaktadır: Farklı politikalar genelinde kota tanımlayıcısı.

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

Özellikler

<MessageWeight> öğesi

Her iletiye atanan ağırlığı belirtmek için kullanılır. Örneğin, diğerlerinden daha fazla bilgi işlem kaynağı tüketen istek mesajlarının etkisini artırmak için mesaj ağırlığını kullanın.

Örneğin, POST mesajlarının GET mesajları kadar "ağır" veya pahalı olmasını istiyorsunuz. Bu nedenle, bir POST için MessageWeight değerini 2, bir GET için ise 1 olarak ayarlarsınız. İsteğin sayacı etkilememesi için MessageWeight değerini 0 olarak da ayarlayabilirsiniz. Bu örnekte, kota dakika başına 10 mesaj ise ve POST istekleri için MessageWeight 2 ise kota, herhangi bir 10 dakikalık aralıkta 5 POST isteğine izin verir. Sayaç sıfırlanmadan önce yapılan ek istekler (POST veya GET) reddedilir.

MessageWeight değerini temsil eden bir değer, akış değişkeniyle belirtilmelidir ve HTTP üstbilgilerinden, sorgu parametrelerinden, XML veya JSON isteği yükünden ya da başka bir akış değişkeninden çıkarılabilir. Örneğin, weight adlı bir başlıkta ayarlarsınız:

<MessageWeight ref="message_weight"/>

Akış değişkenleri

Bir kota politikası yürütüldüğünde aşağıdaki önceden tanımlanmış akış değişkenleri otomatik olarak doldurulur. Akış değişkenleri hakkında daha fazla bilgi için Değişkenler referansı başlıklı makaleyi inceleyin.

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

Kota, ani artışları önleme ve eşzamanlı hız sınırı politikalarını karşılaştırma