Audit-Ereignisse mit Filterung abrufen

In diesem Codeschnipsel sehen Sie, wie Sie eine Liste von Audit-Ereignissen mit Filterung erhalten.

Parameter

Sie können die Liste der zurückgegebenen Ereignisobjekte mit Hilfe von Abfrageparametern filtern. Die Parameter, die angegeben werden können, sind in der folgenden Tabelle aufgeführt:

Abfrage Parameter	Beschreibung
`event_type`	Die Art des Audit-Ereignisses, zum Beispiel: `APP_CREATE`, `NUMBER_ASSIGN`und so weiter. Sie können eine kommagetrennte Liste von Ereignistypen hier.
`search_text`	JSON-kompatible Suchzeichenfolge. Suchen Sie nach einem bestimmten Text in einem Audit-Ereignis.
`date_from`	Abrufen von Audit-Ereignissen ab diesem Datum (im ISO-8601-Format).
`date_to`	Abrufen von Audit-Ereignissen bis zu diesem Datum (im ISO-8601-Format).
`page`	Seitenzahl beginnend mit Seite 1.
`size`	Anzahl der Elemente pro Seite (zwischen 1 und 100, Standardwert 30).

Beispiel

Sie müssen sicherstellen, dass die folgenden ersetzbaren Werte im Beispielcode mit einer geeigneten Methode gesetzt werden:

Schlüssel	Beschreibung
`VONAGE_API_KEY`	Your Vonage API key (see it on your dashboard).
`VONAGE_API_SECRET`	Your Vonage API secret (also available on your dashboard).
`SEARCH_TEXT`	Some JSON compatible text to search for. For example, "number".
`DATE_FROM`	Audit events starting from this ISO-8601 datetime value. For example, "2018-07-01".
`DATE_TO`	Audit events up to this ISO-8601 datetime value. For example, "2018-08-01".

Im folgenden Beispiel wird die Erstellen Sie eine Applikation und Initialisieren Sie Ihre Abhängigkeiten Verfahren sind fakultativ.

Voraussetzungen

Eine Vonage-Applikation enthält die erforderliche Konfiguration für Ihr Projekt. Sie können eine Applikation mit Hilfe von Vonage CLI (siehe unten) oder über das Dashboard erstellen. Mehr über Applikationen erfahren Sie unter siehe unseren Vonage Concepts Leitfaden.

Installieren Sie die CLI

npm install -g nexmo-cli

Erstellen Sie eine Applikation

Sobald Sie die CLI installiert haben, können Sie damit eine Vonage-Anwendung erstellen. Führen Sie den folgenden Befehl aus und notieren Sie sich die Anwendungs-ID, die er zurückgibt. Dies ist der Wert, der im folgenden Beispiel in NEXMO_APPLICATION_ID verwendet wird. Es wird auch private.key im aktuellen Verzeichnis erstellt, das Sie im Schritt Initialisieren Sie Ihre Abhängigkeiten benötigen.

Vonage muss sich mit Ihrem lokalen Rechner verbinden, um auf Ihr answer_url zuzugreifen. Wir empfehlen die Verwendung von ngrok für diesen Zweck. Stellen Sie sicher, dass Sie demo.ngrok.io in den folgenden Beispielen in Ihre eigene ngrok-URL ändern.

nexmo app:create "Get Events with filtering" http://demo.ngrok.io/webhooks/answer http://demo.ngrok.io/webhooks/events --keyfile private.key

Erstellen Sie eine Datei mit dem Namen get-events-with-filtering.sh und fügen Sie den folgenden Code hinzu:

source "../config.sh"

Vollständige Quelle anzeigen

Schreiben Sie den Code

Fügen Sie Folgendes zu get-events-with-filtering.sh hinzu:

curl "https://api.nexmo.com/beta/audit/events?search_text=$SEARCH_TEXT&date_from=$DATE_FROM&date_to=$DATE_TO" \
     -u "$VONAGE_API_KEY:$VONAGE_API_SECRET"

Vollständige Quelle anzeigen

Führen Sie Ihren Code aus

Speichern Sie diese Datei auf Ihrem Rechner und führen Sie sie aus:

./get-events-with-filtering.sh

Voraussetzungen

Installieren Sie die CLI

npm install -g nexmo-cli

Erstellen Sie eine Applikation

nexmo app:create "Get Events with filtering" http://demo.ngrok.io/webhooks/answer http://demo.ngrok.io/webhooks/events --keyfile private.key

npm install @vonage/audit

Erstellen Sie eine Datei mit dem Namen get-events-with-filtering.js und fügen Sie den folgenden Code hinzu:

const { Audit } = require('@vonage/audit');

const auditClient = new Audit({
  apiKey: VONAGE_API_KEY,
  apiSecret: VONAGE_API_SECRET,
});

Vollständige Quelle anzeigen

Schreiben Sie den Code

Fügen Sie Folgendes zu get-events-with-filtering.js hinzu:

const run = async () => {
  const filter = {
    dateFrom: DATE_FROM,
    dateTo: DATE_TO,
    searchText: SEARCH_TEXT,
  };

  try {
    for await (const event of auditClient.getEvents(filter)) {
      console.log(event);
    }
  } catch (error) {
    console.log(error);
  }
};
run();

Vollständige Quelle anzeigen

Führen Sie Ihren Code aus

Speichern Sie diese Datei auf Ihrem Rechner und führen Sie sie aus:

node get-events-with-filtering.js

Probieren Sie es aus

Führen Sie den Befehl in einer Shell aus. Der Aufruf ruft eine gefilterte Liste von Audit-Ereignissen ab.