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

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

En sevdiğiniz metin veya XML destekli düzenleyiciyi ya da IDE'yi kullanarak politikaları yerel olarak oluşturabilir ve düzenleyebilirsiniz. Bu konuda, politika oluşturma, yapılandırma, ekleme, dağıtma ve test etme işlemlerinin nasıl yapılacağını göstermek için örnek olarak Kota politikası türü kullanılmaktadır.

Çoğu API proxy'si kota uygular. Kotalar, bir istemci uygulamasının belirli bir zaman aralığında API'yi ne sıklıkta çağırmasına izin verileceği üzerinde kontrol sağlar. Aşağıdaki örnekte, kota politikası uygulamaları dakikada 1 istek ile sınırlayacak şekilde yapılandırılmıştır. (Bu gerçekçi olmasa da politikanın etkilerini görmenin basit bir yoludur.)

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ü politikası, 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ı manuel olarak oluşturabilir veya politikayı bir XML şemasından oluşturabilirsiniz. Tüm politikaların, politika türüne özgü bazı ayarları ve tüm politikalarda ortak olan bazı ayarları vardır.

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

Tüm politikalarda aşağıdaki özellikler tanımlanır:

  • enabled: Politikanın "açık" mı yoksa "kapalı" mı olduğunu gösterir. Politikalar, bu ayar değiştirilerek çalışma zamanında etkinleştirilebilir veya devre dışı bırakılabilir. enabled değeri false olarak 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 hatalar, kotanın aşıldığını gösterir. Bu nedenle, bu özellik yanlış olarak ayarlanmalıdır.
  • name: Bu politikaya verdiğiniz ad. Bu ad, bu politika örneğine özeldir ve politikayı akışa bir işleme adımı olarak eklemek için kullanılır.

Yukarıdaki örnekte Allow, Interval ve TimeUnit öğeleri kota politikasına özgüdür. 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 Politika Referansı'ndan bilgi edinebilirsiniz.