SpikeArrest politikası

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

Spike Arrest politikası, <Rate> öğesiyle trafik artışlarına karşı koruma sağlar. Bu öğe, bir API proxy'si tarafından işlenen ve arka uca gönderilen isteklerin sayısını kısıtlayarak performans gecikmeleri ve çalışmama süresine karşı koruma sağlar.

<SpikeArrest> öğesi

Spike Arrest politikasını tanımlar.

<SpikeArrest
  continueOnError="[false|true]"
  enabled="[true|false]"
  name="policy_name"
>
  <DisplayName>display_name</DisplayName>
  <Properties/>
  <Identifier ref="flow_variable"/>
  <MessageWeight ref="flow_variable"/>
  <Rate ref="flow_variable">rate[pm|ps]</Rate>
  <UseEffectiveCount>[false|true]</UseEffectiveCount>
</SpikeArrest>

<SpikeArrest async="false" continueOnError="false" enabled="true" name="Spike-Arrest-1">
  <DisplayName>Spike Arrest-1</DisplayName>
  <Properties/>
  <Identifier ref="request.header.some-header-name"/>
  <MessageWeight ref="request.header.weight"/>
  <Rate>30ps</Rate>
  <UseEffectiveCount>true</UseEffectiveCount>
</SpikeArrest>

Bu öğe, tüm politikalarda ortak olan aşağıdaki özelliklere sahiptir:

Örnekler

Aşağıdaki örneklerde, Spike Arrest politikasını kullanabileceğiniz bazı yöntemler gösterilmektedir:

<SpikeArrest name="Spike-Arrest-1">
  <Rate>5ps</Rate>
</SpikeArrest>

<SpikeArrest async="false" continueOnError="false" enabled="true" name="SpikeArreast">
  <DisplayName>SpikeArreast</DisplayName>
  <Rate>300pm</Rate>
</SpikeArrest>

<SpikeArrest name="Spike-Arrest-1">
  <Rate>12pm</Rate>
  <Identifier ref="client_id" />
  <MessageWeight ref="request.header.weight" />
</SpikeArrest>

<SpikeArrest name="Spike-Arrest-1">
  <Rate ref="request.header.runtime_rate" />
</SpikeArrest>

curl http://myorg-myenv.apigee.net/price -H 'runtime_rate:30ps'

Alt öğe referansı

Bu bölümde, <SpikeArrest> öğesinin alt öğeleri açıklanmaktadır.

<DisplayName>

Yönetim kullanıcı arayüzü proxy düzenleyicisinde politikayı farklı ve daha doğal bir adla etiketlemek için name özelliğine ek olarak kullanın.

<DisplayName> öğesi tüm politikalar için ortaktır.

<DisplayName> öğesi şu söz dizimini kullanır:

<PolicyElement>
  <DisplayName>policy_display_name</DisplayName>
  ...
</PolicyElement>

<PolicyElement>
  <DisplayName>My Validation Policy</DisplayName>
</PolicyElement>

<DisplayName> öğesinin özelliği veya alt öğesi yoktur.

<Identifier>

Spike Arrest politikasının istemciye göre uygulanabilmesi için isteklerin nasıl gruplandırılacağını seçmenize olanak tanır. Örneğin, istekleri geliştirici kimliğine göre gruplandırabilirsiniz. Bu durumda, her geliştiricinin istekleri proxy'ye yapılan tüm istekler yerine kendi ani artış durdurma oranına göre sayılır.

İstek azaltma üzerinde daha ayrıntılı kontrol için <MessageWeight> öğesiyle birlikte kullanın.

<Identifier> öğesini boş bırakırsanız söz konusu API proxy'sine yapılan tüm istekler için tek bir hız sınırı uygulanır.

<SpikeArrest
  continueOnError="[false|true]"
  enabled="[true|false]"
  name="policy_name"
>
  <Identifier ref="flow_variable"/>
</SpikeArrest>
        

<SpikeArrest name="Spike-Arrest-1">
  <Identifier ref="developer.id"/>
  <Rate>42pm</Rate/>
</SpikeArrest>

Aşağıdaki tabloda <Identifier> öğesinin özellikleri açıklanmaktadır:

Bu öğe, aşağıdaki Apigee Topluluğu yayınında da ele alınmıştır: http://community.apigee.com/questions/2807/how-does-the-edge-quota-policy-work-when-no-identi.html.

<MessageWeight>

Her ileti için tanımlanan ağırlığı belirtir. Mesaj ağırlığı, tek bir isteğin ani artış durdurma oranının hesaplanmasına olan etkisini değiştirir. Mesaj ağırlığı, HTTP üstbilgisi, sorgu parametresi, form parametresi veya mesaj gövdesi içeriği gibi herhangi bir akış değişkeni olabilir. JavaScript politikasını veya AssignMessage politikasını kullanarak da özel değişkenler kullanabilirsiniz.

Belirli istemcilere veya uygulamalara göre istekleri daha da azaltmak için <Identifier> ile birlikte kullanın.

Örneğin, ani artış durdurma <Rate> değeri 10pm ise ve bir uygulama 2 ağırlığına sahip istekler gönderiyorsa her istek 2 olarak sayıldığı için söz konusu müşteriden dakikada yalnızca beş mesaja izin verilir.

<SpikeArrest
  continueOnError="[false|true]"
  enabled="[true|false]"
  name="policy_name"
>
  <MessageWeight ref="flow_variable"/>
</SpikeArrest>

<SpikeArrest name="Spike-Arrest-1">
  <Rate>12pm</Rate>
  <Identifier ref="client_id" />
  <MessageWeight ref="request.header.weight" />
</SpikeArrest>

Aşağıdaki tabloda <MessageWeight> öğesinin özellikleri açıklanmaktadır:

<Rate>

Dakika veya saniye aralıkları içinde izin verilen istek sayısını ayarlayarak trafik ani artışlarının (veya patlamalarının) sınırlandırılma hızını belirtir. İstemciden gelen değerleri kabul ederek çalışma zamanında trafiği sorunsuz bir şekilde azaltmak için bu öğeyi <Identifier> ve <MessageWeight> ile birlikte de kullanabilirsiniz.

<SpikeArrest
  continueOnError="[false|true]"
  enabled="[true|false]"
  name="policy_name"
>
  <Rate ref="flow_variable">rate[pm|ps]</Rate>
</SpikeArrest>

<SpikeArrest name="Spike-Arrest-1">
  <Rate>5ps</Rate>
</SpikeArrest>

<SpikeArrest async="false" continueOnError="false" enabled="true" name="SpikeArreast">
  <DisplayName>SpikeArreast</DisplayName>
  <Rate>300pm</Rate>
</SpikeArrest>

Aşağıdaki tabloda <Rate> öğesinin özellikleri açıklanmaktadır:

<Rate ref="request.header.custom_rate">1pm</Rate>

<UseEffectiveCount>

Otomatik ölçeklendirme grupları kullanılırken ani artış durdurma sayılarınızı Mesaj İşleyenler (MP'ler) arasında dağıtır.

<SpikeArrest
  continueOnError="[false|true]"
  enabled="[true|false]"
  name="policy_name"
>
  <UseEffectiveCount>[false|true]</UseEffectiveCount>
</SpikeArrest>

<SpikeArrest name='Spike-Arrest-1'>
  <Rate>40ps</Rate>
  <UseEffectiveCount>true</UseEffectiveCount>
</SpikeArrest>

<UseEffectiveCount> öğesi isteğe bağlıdır. Öğe, ani artış önleme politikanızdan çıkarıldığında varsayılan değer false olmaktadır.

Aşağıdaki tabloda <UseEffectiveCount> öğesinin özellikleri açıklanmaktadır:

<UseEffectiveCount> değerinin etkisi şu şekildedir:

• true: Bir MP'nin ani artış oranı sınırı, <Rate> değerinin aynı kapsüldeki mevcut MP sayısına bölünmesiyle elde edilir. Toplam sınır, <Rate> değerinin toplamıdır. Dinamik olarak eklenen (veya kaldırılan) MP'lerin tek tek ani artış oranı sınırları artar (veya azalır), ancak toplam sınır aynı kalır.
• false (atlanırsa varsayılan değerdir): Her MP'nin ani artış oranı sınırı, <Rate> değerinin basitçe kendisidir. Toplam sınır, tüm MP'lerin ücretlerinin toplamıdır. MP'ler eklendiğinde (veya kaldırıldığında) bu MP'lerin bireysel ani artış oranı sınırları aynı kalır ancak toplam sınır artar (veya azalır).

Aşağıdaki tabloda, <UseEffectiveCount>'ün her MP'nin etkin ücret sınırı üzerindeki etkisi gösterilmektedir:

Bu örnekte, MP sayısı 4'ten 2'ye düşürüldüğünde ve <UseEffectiveCount> false olduğunda MP başına etkili oranın aynı (10) kaldığını görebilirsiniz. Ancak <UseEffectiveCount> true olduğunda, milletvekili sayısı 4'ten 2'ye düştüğünde milletvekili başına etkin ücret 10'dan 20'ye çıkar.

Akış değişkenleri

Spike Arrest politikası yürütüldüğünde aşağıdaki akış değişkeni doldurulur:

Daha fazla bilgi için Akış değişkenleri referansı başlıklı makaleyi inceleyin.

Hata referansı

Bu bölümde, döndürülen hata kodları, hata mesajları ve hata değişkenleri açıklanmaktadır. bu politika bir hatayı tetiklediğinde Edge tarafından ayarlanır. Hata kuralları geliştirirken bu bilgilerin farkında olmanız önemlidir. hoşuma gitmesi için bir fırsattır. Daha fazla bilgi edinmek için bkz. 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ı

Bu politikayı içeren bir proxy dağıttığınızda bu hatalar oluşabilir.

Hata değişkenleri

Bu değişkenler, çalışma zamanı hatası oluştuğunda ayarlanır. Daha fazla bilgi için Bilmeniz gerekenler hakkında daha fazla bilgi edinin.

Örnek hata yanıtı

Aşağıda örnek bir hata yanıtı gösterilmektedir:

{  
   "fault":{  
      "detail":{  
         "errorcode":"policies.ratelimit.SpikeArrestViolation"
      },
      "faultstring":"Spike arrest violation. Allowed rate : 10ps"
   }
}

Örnek hata kuralı

Aşağıda, bir SpikeArrestViolation hatasını işleyecek örnek bir hata kuralı gösterilmektedir:

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

Kota veya ani artış durdurma politikası tarafından belirlenen bir hız sınırının aşılması için geçerli HTTP durum kodu 429'tür (Çok Fazla İstek). HTTP durum kodunu 500 (Dahili sunucu hatası) olarak değiştirmek için Update organization properties API'yi kullanarak features.isHTTPStatusTooManyRequestEnabled mülkünü false olarak ayarlayın.

Örneğin:

curl -u email:password -X POST -H "Content-type:application/xml" http://api.enterprise.apigee.com/v1/organizations/myorg -d \
"<Organization type="trial" name="MyOrganization">
    <Properties>
        <Property name="features.isHTTPStatusTooManyRequestEnabled">true</Property>
        . . .
    </Properties>
</Organization>"

Şemalar

Her politika türü bir XML şemasıyla (.xsd) tanımlanır. Referans olarak kullanabileceğiniz politika şemalarını GitHub'da bulabilirsiniz.

İlgili konular

• Kota politikası: Müşterilerdeki trafiği sınırlamak için kota politikası
• Hız sınırlamasına genel bakış için Hız sınırlaması
• Kota ve SpikeArrest Politikalarını Karşılaştırma
• API proxy'lerinin çalışan örnekleri