SpikeArrest politikası

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

Spike Arrest politikası, <Rate> öğesiyle trafik dalgalanmalarına karşı koruma sağlar. Bu öğesi, bir API proxy'si tarafından işlenen ve arka uca gönderilen isteklerin sayısını kısıtlar. performans gecikmelerine ve kapalı kalma sürelerine karşı koruma sağlar.

<SpikeArrest> öğe

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ın kullanım şekillerinden bazıları gösterilmektedir:

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

<SpikeArrest name="Spike-Arrest-1">
  <Rate>12pm</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> alt öğeleri açıklanmaktadır.

<DisplayName>

Politikayı name özelliğine ek olarak farklı, daha doğal bir ada sahip yönetim arayüzü proxy düzenleyicisi.

<DisplayName> öğesi tüm politikalarda 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 yok.

<Identifier>

Spike Arrest politikasının uygulanabilmesi için taleplerin nasıl gruplandırılacağını seçebilmenizi sağlar. gerekir. Örneğin, istekleri geliştirici kimliğine göre gruplandırabilirsiniz. Bu durumda her geliştiricinin talepleri, kendi Spike Arrest oranlarına dahil edilecektir. temsil eder.

Daha ayrıntılı bilgi için <MessageWeight> öğesiyle birlikte kullanın kontrol olanağı sunar.

<Identifier> öğesini boş bırakırsanız tüm istekler için bir hız sınırı uygulanır içine koymanız gerekir.

<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> özellikleri açıklanmaktadır:

Bu unsur, şu Apigee Topluluk gönderisinde de ele alınmaktadı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ıklandırmayı belirtir. Mesaj ağırlığı, etkiyi değiştirir artış oranı. Mesaj ağırlığı herhangi bir değer olabilir HTTP üstbilgisi, sorgu parametresi, form parametresi veya ileti gövdesi içeriği gibi bir akış değişkeni Ayrıca, JavaScript politikasını veya AssignmentMessage politikası.

İstekleri daha fazla daraltmak için <Identifier> ile birlikte kullanın. veya uygulamalara sahip olmanız gerekir.

Örneğin, Spike Arrest <Rate> değeri 10pm olduğunda bir uygulama tarafından gönderilir. ağırlığı 2 olan isteklere sahipse, şuradan dakikada yalnızca beş iletiye izin verilir: çünkü her istek 2 olarak sayılır.

<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> özellikleri açıklanmaktadır:

<Rate>

izin verilen isteklerin sayısını gösterir. Bu öğeyi <Identifier> ve <MessageWeight> ile birlikte şunun için: İstemciden değer kabul ederek çalışma zamanında trafiği sorunsuz şekilde kısıtlar.

<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 name="Spike-Arrest-1">
  <Rate>12pm</Rate>
</SpikeArrest>

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

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

<UseEffectiveCount>

Otomatik ölçeklendirme kullanılırken Spike Arrest sayınızı mesaj işlemcileri (MP) arasında dağıtır. gruplar.

<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. Varsayılan değer: false Öğe, Spike Arrest politikanızdan çıkarıldığında gösterilir.

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

<UseEffectiveCount> işlevinin etkisi, değerine bağlıdır:

• true: MP'in artış oranı sınırı <Rate> değerinin aynı kapsüldeki mevcut MP sayısına bölümü. Toplam sınır, / <Rate>. MP'ler dinamik olarak eklendiğinde (veya kaldırıldığında), hız sınırları artar (veya azalır) ancak toplam sınır aynı kalır.
• false (atlanırsa bu varsayılan değerdir): Her MP'nin artış hızı sınırı: <Rate> değerini alır. Toplam sınır, tüm MP'lerin oranlarının toplamıdır. MP'ler eklendiğinde (veya kaldırıldığında) bağımsız artış oranı sınırları aynı kalır ancak toplam sınır artar (veya azalması) anlamına gelir.

Aşağıdaki tabloda, <UseEffectiveCount> işlevinin geçerli ücret sınırı üzerindeki etkisi gösterilmektedir: her MP:

Bu örnekte, MP'lerin sayısı 4'ten 2'ye düşürüldüğünde <UseEffectiveCount> false, MP başına geçerli ücret aynı kalır ( 10). Ancak <UseEffectiveCount> true olduğunda MP başına geçerli oran MP sayısı 4'ten 2'ye düşürüldüğünde 10'dan 20'ye.

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ı bölümüne bakın.

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ış politikası tarafından belirlenen hız sınırını aşmak için geçerli HTTP durum kodu 429 (Çok Fazla İstek). HTTP durum kodunu 500 olarak değiştirmek için (Dahili Sunucu Hatası), false için features.isHTTPStatusTooManyRequestEnabled özelliğini kullanarak Kuruluş özelliklerini güncelleme API'si.

Ö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 olması amacıyla politika şemaları GitHub'da bulabilirsiniz.

İlgili konular

• Kota politikası: Kota politikası, bireysel istemcilerde trafiği sınırlandırmak için
• Hız sınırlaması için hız sınırlandırma genel bakış
• Karşılaştırma Kota ve SpikeArrest Politikaları
• API proxy'lerinin çalışma örnekleri