XML dosyalarında politika ekleme veya yapılandırma

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

Favori metin veya XML uyumlu düzenleyicinizi ya da IDE'yi kullanarak politikaları yerel olarak oluşturup düzenleyebilirsiniz. Bu konuda; politika oluşturmaya, yapılandırmaya, eklemeye, dağıtmaya ve test etmeye örnek olarak Kota politika türü kullanılmaktadır.

Çoğu API proxy'si bir kota uygular. Kotalar, istemci uygulamasının belirli bir zaman aralığında API'leri çağırmasına ne sıklıkta izin verileceğini kontrol eder. Aşağıdaki örnekte bir Kota politikası, uygulamaları dakikada 1 istekle sınırlayacak şekilde yapılandırılmıştır. (Bu yaklaşım gerçekçi olmasa da bir politikanın etkilerini görmek için basit bir yol sunar.)

Bir API proxy yapılandırmasında, Politika dosyaları /apiproxy/policies dizini altında XML dosyaları olarak depolanır.

Örneğin, "QuotaPolicy" adlı bir Kota türü politika, aşağıdaki içeriğe sahip QuotaPolicy.xml adlı bir dosya olarak oluşturulabilir:

<Quota enabled="true" continueOnError="false" name="QuotaPolicy">
    <Allow count="1"/>
    <Interval>1</Interval>
    <TimeUnit>minute</TimeUnit>
</Quota>

Metin dosyasını elle oluşturabilir veya politikayı bir XML şemasından oluşturabilirsiniz. Tüm politikaların bazı ayarları politika türüne özel, bazıları ise tüm politikalarda geneldir.

Yönetim kullanıcı arayüzüne politika eklediğinizde API proxy oluşturucu, seçtiğiniz politika türü için XML şemasından politika örneğini oluşturur. Bu nedenle, politika yapılandırmasında, belgelere her zaman dahil edilmeyen öğeler görebilirsiniz.

Tüm politikalar aşağıdaki özellikleri tanımlar:

  • enabled: Politikanın "açık" veya "kapalı" olduğunu belirtir. Politikalar çalışma zamanında bu ayar değiştirilerek etkinleştirilebilir veya devre dışı bırakılabilir. enabled politikası false değerine ayarlanmış bir politika zorunlu kılınmaz.
  • continueOnError: Politika başarısız olursa ardışık düzenin mesajı işlemeye devam edip etmeyeceğini tanımlar. Kota politikaları uygulanırken karşılaşılan hatalar muhtemelen kotanın aşıldığını gösterir ve bu nedenle bu özelliğin false (yanlış) değerine ayarlanması gerekir.
  • name: Bu politikaya verdiğiniz ad. Bu ad, bu politika örneğine özgüdür ve politikayı, işleme adımı olarak akışa eklemek için kullanılır.

Yukarıdaki örnekte Allow, Interval ve TimeUnit öğeleri Kota politikasına özeldir. Bu öğeler, API Hizmetleri'nin bir API adına zorunlu kıldığı ayarları sağlar. Diğer politika türleri kendi ayarlarını tanımlar. Bu ayarlar hakkında daha fazla bilgiyi Politika Referansı bölümünde bulabilirsiniz.