API-Nutzungsschwellenereignis

Über das Ereignis “API-Nutzungsschwellenwert

Mit dem Ereignis API können Sie die API Ihrer Instanz überwachen und einen Workflow Auslöser, wenn die Verwendung kritische Ebenen erreicht. Sie können die allgemeine API in Ihrer gesamten Instanz überwachen oder die Überwachung auf bestimmte API, Fehler und Benutzer einschränken.

Einrichten eines API-Nutzungsschwellenereignisses

1. Folgen Sie der verknüpfte Anweisungen um einen ereignisbasierten Workflow anzulegen. Dieses Ereignis ist nur auf der Seite “Eigenständige Workflows” verfügbar.
2. Wählen Sie für das Ereignis API.
   
3. Wählen Sie aus, worüber Sie benachrichtigt werden möchten:
   
   • Rückgang der Erfolgsquote: Auslöser den Workflow aus, wenn ein bestimmter Prozentsatz der Anfragen fehlschlägt.
   • Fehlgeschlagene Authentifizierungsversuche (HTTP 401): Auslöser des Workflow ist eine bestimmte Anzahl von Anfragen, die die Authentifizierung mit einem 401-Fehler fehlschlagen.
   • Erreichen des markenweiten Ratenlimits: Auslöser den Workflow, wenn eine bestimmte Anzahl oder ein bestimmter Prozentsatz des Ratenlimits Ihrer Marke erreicht wurde.
   • Erreichen des API-Limits für den Endpunkt (429 Fehler gefunden): Auslöser für den Workflow, wenn eine bestimmte Anzahl oder ein bestimmter Prozentsatz von Anfragen an einen bestimmten Endpunkt mit einem 429-Fehler fehlschlägt.
   • Spitze der Gesamtzahl der Anrufe für einen Benutzer: Auslöser den Workflow, wenn ein bestimmter Benutzer in Ihrer Lizenz eine bestimmte Anzahl von Anforderungen sendet.
   • Spike von 200s Erfolge: Auslöser den Workflow aus, wenn eine bestimmte Anzahl oder ein bestimmter Prozentsatz von Anfragen mit einer 200-Nachricht erfolgreich ist.
   • Spike von 400s/500s (außer 401s und 429s): Auslöser des Workflows, wenn ein bestimmter Prozentsatz der Anfragen mit 400er oder 500er Fehlern fehlschlägt, ausgenommen 401er und 429er Fehler.
4. Legen Sie den Schwellenwert für Ihre Benachrichtigung fest. Was Sie hier eingeben, hängt von der Art der Meldung ab, die Sie ausgewählt haben.
5. Wählen Sie aus, wie oft Ihr Schwellenwert geprüft werden soll:
   • Stündlich: Jede Stunde, 15 Minuten nach der Spitze der Stunde.
   • Täglich um 12:00 Uhr UTC
6. Klicken Sie auf Speichern.
7. Aufgabe hinzufügen zu Ihrem Workflow. Dies ist die Aufgabe, die die Meldung anlegt. Zu den allgemeinen Aufgaben gehören:
   • Aufgabe: Erstellen Sie eine Qualtrics, wenn der Workflow ausgelöst wird.
   • E-mail-aufgabe: Senden Sie eine E-Mail, wenn der Workflow ausgelöst wird.
8. Beim Einrichten Ihrer Aufgabe können Sie Folgendes verwenden: dynamischer Text um Informationen aus dem Auslöser abzurufen:
   
   • Ereignisse für api usage domain event: Die Gesamtzahl der Ereignisse des von Ihnen gewählten Benachrichtigungstyps
     Beispiel: Wenn „Spike of 400s“ ausgewählt wurde, würde der dynamischer Text die Anzahl der 400 Fehler enthalten.
   • Öffentlicher API – aufgerufen: Zeigt den spezifischen API an, der aufgerufen wurde.
   • Schwellenwerttyp für Benachrichtigung über api: Zeigt die Art der von Ihnen ausgewählten Schwellenwertbenachrichtigung an.
   • Gesamtzahl der Endpunktaufrufe für das Ereignis “Api usage domain”: Bei der Überwachung eines bestimmten API-Endpunkts ist dies die Gesamtzahl der Aufrufe für diesen Endpunkt.
   • Benutzer-ID, die die API vorgenommen hat: Die Benutzer-ID des Benutzers, der die API gestellt hat.