Löschen eines Ziel-Datenflusses mithilfe der Flow Service-API

Letzte Aktualisierung: 2022-06-23
  • Erstellt für:
  • Developer
    User
    Admin
    Leader

Sie können Datenflüsse löschen, die Fehler enthalten oder mit der Funktion Flow Service API.

In diesem Tutorial werden die Schritte zum Löschen von Datenflüssen an Batch- und Streaming-Ziele mithilfe von Flow Service.

Erste Schritte

Für dieses Tutorial benötigen Sie eine gültige Fluss-ID. Wenn Sie keine gültige Fluss-ID haben, wählen Sie Ihr Ziel aus der Zielkatalog und führen Sie die Schritte aus, die beschrieben wurden, um Verbindung zum Ziel herstellen und Daten aktivieren vor dem Versuch dieses Tutorials.

Dieses Tutorial setzt außerdem ein Grundverständnis der folgenden Komponenten von Adobe Experience Platform voraus:

Die folgenden Abschnitte enthalten zusätzliche Informationen, die Sie benötigen, um einen Datenfluss mithilfe der Flow Service API.

Lesen von Beispiel-API-Aufrufen

In diesem Tutorial wird anhand von Beispielen für API-Aufrufe die korrekte Formatierung von Anfragen aufgezeigt. Dazu gehören Pfade, erforderliche Kopfzeilen und ordnungsgemäß formatierte Anfrage-Payloads. Außerdem wird ein Beispiel für eine von der API im JSON-Format zurückgegebene Antwort bereitgestellt. Informationen zu den Konventionen, die in der Dokumentation für Beispiel-API-Aufrufe verwendet werden, finden Sie im Abschnitt zum Lesen von Beispiel-API-Aufrufen im Handbuch zur Fehlerbehebung für Experience Platform

Sammeln von Werten für erforderliche Kopfzeilen

Um Platform-APIs aufzurufen, müssen Sie zunächst das Authentifizierungs-Tutorial abschließen. Durch Abschluss des Authentifizierungs-Tutorials werden die Werte für die einzelnen erforderlichen Header in allen Experience Platform-API-Aufrufen bereitgestellt, wie unten dargestellt:

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {ORG_ID}

Alle Ressourcen in Experience Platform, einschließlich der Ressourcen, die zu Flow Service gehören, werden in bestimmten virtuellen Sandboxes isoliert. Bei allen Anfragen an Platform-APIs ist eine Kopfzeile erforderlich, die den Namen der Sandbox angibt, in der der Vorgang ausgeführt werden soll:

  • x-sandbox-name: {SANDBOX_NAME}
HINWEIS

Wenn die Variable x-sandbox-name -Kopfzeile nicht angegeben ist, werden Anfragen unter der prod Sandbox.

Bei allen Anfragen, die eine Payload enthalten (POST, PUT, PATCH), ist eine zusätzliche Medientyp-Kopfzeile erforderlich:

  • Content-Type: application/json

Ziel-Datenfluss löschen

Mit einer vorhandenen Fluss-ID können Sie einen Ziel-Datenfluss löschen, indem Sie eine DELETE-Anfrage an die Flow Service API.

API-Format

DELETE /flows/{FLOW_ID}
Parameter Beschreibung
{FLOW_ID} Die eindeutige id -Wert für den Ziel-Datenfluss, den Sie löschen möchten.

Anfrage

curl -X DELETE \
    'https://platform.adobe.io/data/foundation/flowservice/flows/455fa81b-f290-4222-94b6-540a73e3fbc2' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

Antwort

Eine erfolgreiche Antwort gibt den HTTP-Status 202 (kein Inhalt) und leeren Text zurück. Sie können den Löschvorgang bestätigen, indem Sie eine Suchanfrage (GET) an den Datenfluss stellen. Die API gibt den HTTP-Fehler 404 (Nicht gefunden) zurück, der angibt, dass der Datenfluss gelöscht wurde.

Umgang mit API-Fehlern

Die API-Endpunkte in diesem Tutorial folgen den allgemeinen Grundsätzen für die Fehlermeldung bei der Experience Platform-API. Siehe API-Statuscodes und Fehler in der Anfragekopfzeile Weitere Informationen zur Interpretation von Fehlerantworten finden Sie im Handbuch zur Fehlerbehebung bei Platform .

Nächste Schritte

In diesem Tutorial haben Sie erfolgreich die Flow Service API zum Löschen eines vorhandenen Datenflusses in ein Ziel.

Wie Sie diese Vorgänge mithilfe der Benutzeroberfläche durchführen können, erfahren Sie im Tutorial Löschen von Datenflüssen in der Benutzeroberfläche.

Sie können jetzt fortfahren und Zielkonten löschen mithilfe der Flow Service API.

Auf dieser Seite