Sie lesen gerade die Dokumentation zu Apigee Edge.
Zur
Dokumentation zuApigee X wechseln. info
Die Kontingentrichtlinie wird verwendet, um die Anzahl der Anfragen zu zählen, die von einem API-Proxy empfangen werden. Mit dieser Funktion können API-Anbieter Limits für die Anzahl von API-Aufrufen festlegen, die von Apps über einen bestimmten Zeitraum ausgeführt werden.
Die Kontingentrichtlinie kann ein
identifier-Element enthalten, das den Kontingent-Bucket identifiziert, in dem jede Anfrage gezählt
wird.
Anti-Pattern
Verwenden Sie bei der Verwendung der Kontingentrichtlinie keine Kennungen mit hoher Kardinalität.
Die Kardinalität bezieht sich auf die Anzahl der eindeutigen Datenwerte in einem Satz. Eine Kennung mit hoher Kardinalität hat eine große Anzahl unterschiedlicher möglicher Werte. Kennungen mit hoher Kardinalität sind beispielsweise eindeutige Anfrage-IDs oder Sitzungs-IDs, die sich bei jedem API-Aufruf ändern.
Die Verwendung von Kennungen mit hoher Kardinalität kann die Effektivität der Kontingent durchsetzung erheblich beeinträchtigen.
Auswirkungen
Die Verwendung von Kennungen mit hoher Kardinalität für das Kennungselement Ihrer Kontingentrichtlinie führt zu Folgendem:
- Ineffektive Kontingentdurchsetzung: Jede eindeutige Kennung wird als separater Zähler behandelt. Wenn jede Anfrage eine neue, eindeutige ID hat, erstellt Ihr Kontingentsystem im Grunde für jeden API-Aufruf einen neuen Bucket. Das bedeutet, Ihr Gesamtkontingent wird anhand einzelner, einmaliger Zähler gemessen und nicht anhand tatsächlicher Gruppen von Anfragen, die Sie begrenzen möchten. Dadurch ist die Richtlinie für die Traffic-Steuerung nutzlos.
- Erhöhter Ressourcenverbrauch: Das Generieren und Verwalten einer großen Anzahl eindeutiger Kontingentzähler belastet die Apigee-Plattform unnötig, was zu einem erhöhten Ressourcenverbrauch und potenziellen Leistungsproblemen führt.
- Herausforderungen bei der Überwachung: Es wird schwierig, die tatsächlichen API-Verbrauchstrends zu beobachten und zu verstehen, wenn die Daten auf eine große Anzahl eindeutiger Kennungen verteilt sind. Sie können nicht mehr sehen, welche Anwendungen, Entwickler oder Produkte Ihre API-Ressourcen verbrauchen.
Best Practice
Wählen Sie Kennungen mit niedriger bis mittlerer Kardinalität aus, die auch eine stabile und aussagekräftige Gruppierung für die Kontingentdurchsetzung darstellen. So können Sie die API-Nutzung effektiv verwalten und Einblicke in Ihren Traffic erhalten. Beispiele:
- developer.app.name
- client_id
- apiproduct.name
Mit geeigneten Kennungen kann Ihre Kontingentrichtlinie den API-Traffic effektiver verwalten, unbeabsichtigte Überschreitungen verhindern und klare Einblicke in Nutzungsmuster bieten.