Retour

Gestion des tâches en utilisant l’API publique de Talend Cloud Management Console

Temps de lecture : 4 minutes

Introduction :

L’API publique de Talend Cloud Management Console permet aux utilisateurs de gérer Talend Management Console (TMC) à partir d’un système externe (Par exemple, un planificateur, un script ou un ERP,…etc.). Dans ce tutoriel, vous allez apprendre comment récupérer la liste de vos tâches, exécuter une tâche, mettre fin à l’exécution d’une tâche et récupérer le statut d’exécution de votre tâche à partir d’un système externe.

Prérequis :

  • Avoir une souscription Talend Cloud.
  • Avoir le jeton d’accès à Talend Cloud Management Console.
  • Avoir des connaissances sur le fonctionnement d’une API REST.

URL et opérations supportées par l’API de la TMC

Il y a trois URL, chacune pour une région différente de Talend Cloud. Cependant, la liste des opérations ne varie pas en fonction de la région.

Les opérations de l’API se composent d’exécutables et d’exécutions, avec un ensemble distinct d’opérations disponibles pour chacun d’entre eux.

  • Pour les opérations relatives aux exécutables, la méthode GET permet d’obtenir des informations sur les exécutables, telles que les tâches, les plans et les promotions.
  • Pour les opérations relatives aux exécutions, il s’agit d’exécuter ou de mettre fin à l’aide de la méthode POST, DELETE ou GET.

Liste des opérations supportées pour les tâches

Voici les opérations disponibles pour accéder à une tâche ou à ses détails, et pour gérer l’exécution d’une tâche :

Cette liste est disponible sur l’interface Swagger de la documentation de l’API via ce lien.

Récupération de la liste des tâches

Pour cela, nous allons utiliser Postman comme system externe en suivant les étapes suivantes :

  1. Dans Postman, créez une nouvelle requête en saisissant l’URL suivante qui se compose de la ressource selon votre région (US, EU, APAC) + «  /executables/tasks ». Dans notre exemple c’est : https://api.eu.cloud.talend.com/tmc/v2.6/executables/tasks.
  2. Dans l’interface Postman de votre requête, choisissez la méthode GET :

3. Dans la section Authorization, sélectionnez Bearer Token et collez votre jeton d’accès à la TMC.

4.Exécutez votre requête et visualisez la réponse contenant la liste de vos tâches en format JSON.

Exécution d’une tâche

Pour exécuter une tâche, utilisez l’URL « /executions » avec la méthode POST et spécifiez l’ID d’exécution et les paramètres que vous voulez utilisez dans le corps de la requête en format JSON comme le montre l’exemple suivant :

Ensuite, lancez votre requête qui permettra d’exécuter la tâche dans la TMC et en réponse vous allez récupérer un ID d’exécution qui vous permettra de vérifier le statut d’exécution de votre tâche.

Mettre fin à l’exécution d’une tâche

Pour mettre fin à une tâche en cours d’exécution, utilisez l’URL « /executions/{id} » en utilisant la méthode DELETE et l’ID que vous avez récupérer dans l’étape précédente (exécution d’une tâche). La figure ci-dessous montre un exemple dans Postman avec la configuration :

Récupérer le statut d’exécution de la tâche

Pour récupérer le statut de l’exécution de votre tâche utilisez l’URL « /executions/{id} » à l’aide de la méthode GET. Cette opération de récupération du statut d’exécution par ID permet de savoir si la tâche est en cours, si elle a été achevée ou si elle a échoué.

Dans la capture d’écran ci-dessous, pour un ID d’exécution récupérer précédemment, vous pouvez constater le statut d’exécution bien détaillé.

Vous savez désormais comment gérer vos tâches depuis un système externe en utilisant l’API public de Talend Management Console.

Laisser un commentaire

Il n'y a pas de commentaires pour le moment. Soyez le premier à participer !