Sıfırlama Politikası

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

Ne

Hedef Kota politikasının izin verdiği kalan istek sayısını dinamik olarak değiştirmek için kullanın. Bu politikayı genellikle kota sayısının sıfırlanmasını beklemek yerine hedef Kota politikasının mevcut kota sayısını azaltmak için kullanırsınız.

Örneğin, hedef Kota politikası, bir geliştiriciyi haftada 1.000 istekle sınırlandırır. Geliştirici, haftanın ikinci gününde bu sınıra ulaşmıştır. Haftanın geri kalanında 500 ek isteğe izin vermek için Kotayı Sıfırla politikasını kullanarak kota sayacından 500 çıkarın. Haftanın sonunda Kota politikası sıfırlanır ve geliştirici, o hafta için 1.000 isteğe geri döner.

Kota politikası hakkında daha fazla bilgi için Kota politikası bölümüne bakın. Kota Sıfırlama politikasını kullanma hakkındaki bu topluluk yayınına da göz atın.

Sana Özel

Bu politika kodu örnekleri, kota sayaçlarının nasıl sıfırlanacağını gösterir:

Varsayılan Sayacı Sıfırla

<ResetQuota name="resetQuota">
   <Quota name="MyQuotaPolicy">
      <Identifier name="_default">
         <Allow>100</Allow>
      </Identifier>
   </Quota>
</ResetQuota>

Kotayı Sıfırlama politikası, <Quota> etiketinin name özelliğini kullanarak hedef Kota politikasını belirtir. Yukarıdaki örnekte Hedef, MyQuotaPolicy politikasıdır.

Tüm Kota Sıfırlama politikaları, <Identifier> etiketinin Kota politikasında güncellenecek sayacı belirtmesini gerektirir. Kota politikası aynı zamanda <Identifier> etiketini içermediği sürece Kota politikasının varsayılan olarak tek bir sayacı vardır. Bu örnekte, hedef Kota politikası <Identifier> etiketini kullanmadığından name özelliğini _default olarak belirtirsiniz.

<Allow> öğesi, hedef politikadaki geçerli kota sayısını azaltmak için kullanılan değeri belirtir. Bu örnekte, hedef Kota politikasına 100 istek daha gönderilmesi için kota sayısı 100 oranında azaltılmıştır. Hedef Kota politikası sıfırlandığında bu değişiklik silinir.

Aşağıda hedef Kota politikasının tanımı gösterilmektedir:

<Quota name="MyQuotaPolicy">
  <Interval>5</Interval>
  <TimeUnit>hour</TimeUnit>
  <Allow count="100"/>
</Quota>

Referans Kullanma

<ResetQuota name="resetQuota">
   <Quota ref="request.header.quotapolicy">
      <Identifier name="_default">
         <Allow ref="request.header.allowquota" />
      </Identifier>
   </Quota>
</ResetQuota>

Bu örnekte, istekteki başlıklar olarak hedef Kota politikasının adını ve kota politikasındaki değişikliği iletirsiniz. Ardından Kota Sıfırla politikasında bu değerleri içeren akış değişkenlerine başvurabilirsiniz.

Tanımlayıcıyı Belirtin

<ResetQuota name="resetQuota">
   <Quota name="QuotaPolicy">
      <Identifier ref="request.header.clientId">
         <Allow>100</Allow>
      </Identifier>
   </Quota>
</ResetQuota>

Hedef Kota politikası <Identifier> etiketini belirtiyorsa belirli bir kota sayısını güncellemek için Kota Sıfırla politikasının <Identifier> etiketine aynı değeri belirtebilirsiniz. Aşağıdaki hedef Kota politikasındaki <Identifier> etiketinin Kotayı Sıfırla politikasıyla belirtilen değerle nasıl eşleştiğine dikkat edin:

<Quota name="QuotaPolicy">
  <Identifier ref="request.header.clientId"/> 
  <Interval>5</Interval>
  <TimeUnit>hour</TimeUnit>
  <Allow count="100"/>
</Quota>

Öğe referansı

Öğe referansı, Kotayı Sıfırla politikasının öğelerini ve özelliklerini açıklar.

<ResetQuota async="false" continueOnError="false" enabled="true" name="Reset-Quota-1">
   <DisplayName>Reset Quota 1</DisplayName>
   <Quota name="quotaName" ref="request.header.quotapolicy">
      <Identifier name="identifierName" ref="request.header.identifier">
         <Class ref="request.header.classIdentifier" />
         <Allow>100</Allow>
      </Identifier>
   </Quota>
</ResetQuota>

<ResetQuota> özellikleri

<ResetQuota async="false" continueOnError="false" enabled="true" name="Reset-Quota-1"> 

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

Özellik Açıklama Varsayılan Varlık
name

Politikanın dahili adı. name özelliğinin değeri harf, sayı, boşluk, kısa çizgi, alt çizgi ve nokta içerebilir. Bu değer 255 karakterden uzun olamaz.

İsteğe bağlı olarak, politikayı yönetim kullanıcı arayüzü proxy düzenleyicisinde farklı bir doğal dil adıyla etiketlemek için <DisplayName> öğesini kullanın.

Yok Gerekli
continueOnError

Bir politika başarısız olduğunda hata döndürülmesi için false olarak ayarlayın. Bu, çoğu politika için beklenen davranıştır.

Bir politika başarısız olduktan sonra bile akış yürütülmesinin devam etmesi için true değerine ayarlayın.

false İsteğe bağlı
enabled

Politikayı uygulamak için true değerine ayarlayın.

Politikayı devre dışı bırakmak için false olarak ayarlayın. Bu politika, bir akışa bağlı kalsa bile uygulanmaz.

true İsteğe bağlı
async

Bu özellik kullanımdan kaldırıldı.

false Kullanımdan kaldırıldı

<DisplayName> öğesi

Politikayı, yönetim kullanıcı arayüzü proxy düzenleyicisinde farklı bir doğal dil adıyla etiketlemek için name özelliğine ek olarak kullanın.

<DisplayName>Policy Display Name</DisplayName>
Varsayılan

Yok

Bu öğeyi çıkarırsanız politikanın name özelliğinin değeri kullanılır.

Varlık İsteğe bağlı
Tür Dize

<Quota> öğesi

Sayacının güncellenmesi gereken hedef Kota politikasını tanımlar.

<Quota name="quotaName"  ref="request.header.quotapolicy">
   <Identifier name="identifierName" ref="request.header.identifier">
      <Allow>100</Allow>
   </Identifier>
</Quota>
Varsayılan: Yok
Bulunma: Gerekli
Tür: Yok

Özellikler

Özellik Açıklama Varsayılan Varlık
ad

Hedef Kota politikasının adını belirtir.

Yok İsteğe bağlı
referans Hedef Kota politikasının adını içeren bir akış değişkeni. Hem ref hem de name belirtilirse ref öncelikli olur. ref, çalışma zamanında çözümlenemezse name kullanılır. Yok İsteğe bağlı

<Quota>/<Identifier> öğesi

Hedef Kota politikası <Identifier> etiketini belirtiyorsa sayacı benzersiz bir şekilde tanımlamak için kullanılan değişken.

<Quota name="quotaName">
   <Identifier name="identifierName" ref="request.header.identifier">
      <Allow>100</Allow>
   </Identifier>
</Quota>
Varsayılan: Yok
Bulunma: Gerekli
Tür: Dize

Özellikler

Özellik Açıklama Varsayılan Varlık
ad

Hedef Kota politikasındaki sayı tanımlayıcısının adını belirtir. <Identifier> etiketini kullanmayan bir Kota politikası için _default değerini belirtin.

Yok İsteğe bağlı
referans

Hedef Kota politikasındaki sayı tanımlayıcısının adını içeren bir akış değişkeni. Hem ref hem de name belirtilirse ref öncelikli olur. ref, çalışma zamanında çözümlenemezse name kullanılır.

Yok İsteğe bağlı

<Quota>/<Identifier>/<Allow> öğesi

Kota sayacının azaltılacağı miktarı belirtir. <Allow> değerinin belirtilmesi gerekir. Aksi takdirde politika, kotayı değiştirmez.

<Identifier name="identifierName" ref="request.header.identifier">
   <Allow ref="request.header.allowquota">100</Allow>
</Identifier>
Varsayılan: Yok
Bulunma: Gerekli
Tür: Tamsayı

Özellikler

Özellik Açıklama Varsayılan Varlık
referans

Hedef Kota politikasındaki kota sayısında yapılan değişikliği içeren bir akış değişkeni.

Yok İsteğe bağlı

<Quota>/<Identifier>/<Class> öğesi

Kota sayacının güncellendiği sınıfı belirtir. Kota politikasıyla sınıfı kullanma hakkında daha fazla bilgi için Kota politikası bölümüne bakın.

<Identifier name="_default">
   <Class ref="request.header.classIdentifier">
     <Allow>200</Allow>
   </Class>
</Identifier>
Varsayılan: Yok
Bulunma: İsteğe bağlı
Tür: Yok

Özellikler

Özellik Açıklama Varsayılan Varlık
referans

Güncellenecek kota sınıfını içeren akış değişkenine referans.

Yok İsteğe bağlı

Hata referansı

Bu bölümde, bu politika bir hatayı tetiklediğinde Edge tarafından ayarlanan hata kodları ile hata mesajları ve döndürülen hata mesajları ile Edge tarafından ayarlanan hata değişkenleri açıklanmaktadır. Bu bilgiyi, hataları ele almak için hata kuralları geliştirip geliştirmediğinizi bilmeniz önemlidir. Daha fazla bilgi için Politika hataları hakkında bilmeniz gerekenler ve Hataları işleme bölümlerine bakın.

Çalışma zamanı hataları

Politika yürütüldüğünde bu hatalar ortaya çıkabilir.

Hata kodu HTTP durumu Neden Düzelt
policies.resetquota.InvalidRLPolicy 500 Kotayı Sıfırla politikasının <Quota> öğesinde belirtilen Kota politikası, API proxy'sinde tanımlanmadığından akış sırasında kullanılamaz. <Quota> öğesi zorunludur ve sayacının Kota Sıfırlama politikası aracılığıyla güncellenmesi gereken hedef Kota politikasını tanımlar.
policies.resetquota.FailedToResolveAllowCountRef Yok Politikanın <Allow> öğesinde izin verilen sayıyı içeren değişken referansı bir değere çözümlenemez. Bu öğe zorunludur ve kota sayacının azaltılacağı miktarı belirtir.
policies.resetquota.FailedToResolveRLPolicy 500 <Quota> öğesinde ref özelliği tarafından başvurulan değişken çözümlenemiyor.

Dağıtım hataları

Bu hatalar, bu politikayı içeren bir proxy dağıttığınızda ortaya çıkabilir.

Hata adı Neden Düzelt
InvalidCount Kotayı Sıfırlama Politikası'nın <Allow> öğesinde belirtilen sayı değeri tam sayı değilse API proxy'sinin dağıtımı başarısız olur.

Şemalar

İlgili konular

Kota politikası