Automatisieren einer Vorbereitungsausführung über die API

Zusätzlich zur Funktion Run (Ausführen) der Talend Cloud Data Preparation-Anwendung können auch Vorbereitungen mithilfe von API-Aufrufen mit wenig bis gar keiner Konfiguration ausgeführt werden.

Diese Option bedeutet, dass Sie auch Qlik Application Automation oder ein beliebiges anderes Drittanbietertool verwenden können, um Ihre Vorbereitungsausführungen zu planen und zu automatisieren.

In diesem Beispiel wird eine vorhandene Vorbereitung mit dem Namen customers_preparation verwendet, die auf einem Datensatz mit Kundendaten in einer Datenbank basiert. Die Vorbereitung wendet einige Formatierungsvorgänge auf die Daten an und wurde mit einem neuen Datensatz ausgeführt. Jetzt verwenden Sie API-Aufrufe, um diese Vorbereitung erneut auszuführen und eingehende Daten regelmäßig zu bereinigen. In der folgenden Dokumentation werden die vier Hauptschritte beim Ausführen einer Vorbereitung beschrieben: Vorbereitungen auflisten, eine Ausführung starten, die Ausführung überwachen und den Verlauf abrufen.

Tipp: Die Ausführungs-API wählt automatisch die Ausführungskonfiguration aus, die der letzten erfolgreichen Ausführung entspricht, welche von einem Benutzer manuell über die Talend Cloud Data Preparation-Benutzeroberfläche ausgeführt wurde. Das kann im Fall zu automatisierten API-Ausführungen zu Problemen führen. Wenn Ihre Vorbereitung bereit für eine Ausführung über eine API ist, wird empfohlen, sie zu duplizieren und in einem eigenen Ordner abzulegen. Auf diese Weise haben die manuellen Ausführungen keinen Einfluss auf diese Vorbereitung.

Wenn Sie sich die Dokumentation der in diesem Szenario verwendeten API-Endpunkte ansehen möchten, öffnen Sie die Seite der Swagger-Dokumentation, die Ihrer Umgebung entspricht, und wählen Sie Talend Data Preparation - Run API aus. Weitere Informationen finden Sie unter „Zugreifen auf die Dokumentation der REST-API von Talend Data Preparation“.

Vorbereitungen

Um eine Vorbereitung über die API auszuführen, müssen Sie die folgenden Bedingungen erfüllen:

Sie haben Zugriff auf die Vorbereitung als Besitzer oder über eine Freigabe.
Sie haben die Vorbereitung mindestens einmal manuell in der Talend Cloud Data Preparation-Schnittstelle gestartet.
Das Vorbereitungsziel ist nicht Direkter Download.
Sie haben Zugriff auf die den Zieldatensatz als Besitzer oder über eine Freigabe.
Die manuelle Vorbereitungsausführung war erfolgreich.

Vorbereitungs-ID abrufen

Der erste Schritt besteht in der Verwendung eines Endpunkts, um die kompatiblen Vorbereitungen aufzulisten, und im Abrufen der ID der Vorbereitung, die Sie ausführen möchten. Der Name des für diesen Schritt verwendeten Endpunkts ist List preparations (Vorbereitungen auflisten).

Prozedur

Geben Sie mithilfe der GET-Methode den folgenden Endpunkt ein:
```
https://<tdp_environment>/transform/preparations/automation/preparations
```
In diesem und den folgenden Beispielen entspricht <tdp_environment> der URL Ihrer Talend Cloud Data Preparation-Instanz. Weitere Informationen dazu, welche URL abhängig von Ihrem Datencenter verwendet werden muss, finden Sie unter Zugriff auf Talend Cloud-Anwendungen.
Senden Sie den Request.
Der Antwort-Header sieht wie folgt aus:
```
[
  {
    "id": "74604d94-c013-4a58-b3c6-00b0075a35f4",
    "name": "customers_preparation",
    "folder": "preparations"
  }
]
```
Der / im Ordnerfeld bedeutet, dass sich die Vorbereitung im Stammordner von Talend Cloud Data Preparation befindet. Wenn sie sich in einem anderen Ordner befände, sähe der Pfad wie folgt aus: /<ordner_1>/<unterordner_1>.

Ergebnisse

Kopieren Sie die abgerufene ID der Vorbereitung, in diesem Beispiel 74604d94-c013-4a58-b3c6-00b0075a35f4. Sie benötigen sie, um im nächsten Schritt die Vorbereitung zu starten. Alternativ können Sie die Vorbereitungs-ID auch aus der URL der geöffneten Vorbereitung in Talend Cloud Data Preparation abrufen.

Vorbereitung ausführen

Indem Sie zuvor abgerufene ID der Vorbereitung verwenden, rufen Sie den Endpunkt ab, der zum tatsächlichen Ausführen der Vorbereitung verwendet wird. Der Name des für diesen Schritt verwendeten Endpunkts ist Run preparation (Vorbereitung ausführen).

Prozedur

Geben Sie mithilfe der POST-Methode den folgenden Endpunkt ein:

https://<tdp_environment>/transform/preparations/automation/preparations/<preparation_id>/runs

Senden Sie den Request.
Der Antwort-Header sieht wie folgt aus:
```
{
  "id": "848df626-1389-40b9-a7ba-5719faf12e86"
}
```

Ergebnisse

Die Vorbereitungsausführung wurde gestartet, und die in diesem Fall abgerufene ID ist eine „Ausführungs-ID“ und keine „Vorbereitungs-ID“. Kopieren Sie den Wert der ID, in diesem Beispiel 848df626-1389-40b9-a7ba-5719faf12e86. Sie benötigen ihn für den Überwachungsendpunkt.

Die Vorbereitungsausführung überwachen

Nachdem die Ausführung jetzt gestartet wurde, können Sie einen anderen Endpunkt verwenden, um ihren Status zu überwachen. Verwenden Sie die Ausführungs-ID, die Sie im vorigen Schritt abgerufen haben. Der Name des für diesen Schritt verwendeten Endpunkts ist Get run (Ausführung abrufen).

Prozedur

Geben Sie mithilfe der GET-Methode den folgenden Endpunkt ein:

https://<tdp_environment>/transform/preparations/automation/runs/<run_id>

Senden Sie den Request.

Der Antwort-Header sieht wie folgt aus:

{
  "id": "848df626-1389-40b9-a7ba-5719faf12e86",
  "preparationId": "74604d94-c013-4a58-b3c6-00b0075a35f4",
  "status": "FINISHED",
  "start": "2024-07-25T21:03:49.919Z",
  "duration": "PT41.278S"
}

Die möglichen Status für Ihre Ausführung sind:

QUEUEING
RUNNING
FINISHED
ERROR
NO_MORE_AVAILABLE_EXECUTOR
SEMANTIC_TYPES_UNAVAILABLE

Ergebnisse

Der Antwort-Header zeigt im Feld Status, dass die Ausführung der Vorbereitung abgeschlossen ist. Wenn während der Ausführung ein Fehler auftritt, enthält die Antwort auch ein umfassendes Protokoll, damit Sie die Fehlerursache identifizieren können.

Ausführungsverlauf abrufen

Die Vorbereitung wurde mindestens einmal mithilfe der API gestartet, was bedeutet, dass Sie jetzt mithilfe der Vorbereitungs-ID den Ausführungsverlauf für diese konkrete Vorbereitung einsehen können. Der Name des für diesen Schritt verwendeten Endpunkts ist Get run history (Ausführungsverlauf abrufen).

Prozedur

Geben Sie mithilfe der GET-Methode den folgenden Endpunkt ein:

https://<tdp_environment>/transform/preparations/automation/preparations/<preparation_id>/runs

Senden Sie den Request.

Der Antwort-Header sieht wie folgt aus:

[
  {
    "id": "848df626-1389-40b9-a7ba-5719faf12e86",
    "preparationId": "74604d94-c013-4a58-b3c6-00b0075a35f4",
    "status": "FINISHED",
    "start": "2024-07-25T21:03:49.919Z",
    "duration": "PT41.278S"
  }
]

Ergebnisse

Es wird eine Zusammenfassung der letzten Ausführungen und ihrer Status angezeigt. Die Antwort zeigt in diesem Beispiel nur eine Ausführung; es werden aber mehrere angezeigt, wenn Sie eine Vorbereitung wiederholt ausführen.

Der in der Antwort abgerufene Verlauf zeigt nur Ausführungen, die über die API gestartet wurden. Im Gegensatz dazu zeigt Run history (Ausführungsverlauf) auf der Talend Cloud Data Preparation-Schnittstelle nur Ausführungen, die manuell in der Anwendung gestartet wurden.

Hat diese Seite Ihnen geholfen?

Wenn Sie ein Problem mit dieser Seite oder ihrem Inhalt feststellen, sei es ein Tippfehler, ein ausgelassener Schritt oder ein technischer Fehler, informieren Sie uns bitte!

Geben Sie hier Ihr Feedback ab