API de la MetaServlet de Talend Administration Center

L'API de la MetaServlet de Talend Administration Center est une API HTTP de type RPC, (non RESTful) très simple d'utilisation et qui peut être facilement encapsulée dans une interface RESTful, si vous le souhaitez.

API de la MetaServlet

Toutes les opérations de la MetaServlet peuvent être invoquées via une requête HTTP POST ou GET. Tous les paramètres de l'opération sont encodés en tant que seul paramètre sans nom en base 64 pour la requête.

L'invite de commande de la MetaServlet de Talend Administration Center est disponible dans le dossier suivant du répertoire d'installation de Talend Administration Center :

<tomcat_path>/webapps/org.talend.administrator/WEB-INF/classes/MetaServletCaller.bat sous Windows

<tomcat_path>/webapps/org.talend.administrator/WEB-INF/classes/MetaServletCaller.sh sous Linux

Lors de l'exécution de MetaServletCaller sans aucun argument, le message d'aide de haut niveau s'affiche :

<tomcat_path>\webapps\tac\WEB-INF\classes>MetaServletCaller.bat
usage: Missing required option: url
 -f,--format-output          format Json output
 -h,--help                   print this help message
 -json,--json-params <arg>   Required params in a Json object
 -url,--tac-url <arg>        TAC's http url
 -v,--verbose                display more informations

--tac-url

Pour obtenir l'intégralitéèè du message d'aide, le service Talend Administration Center doit être opérationnel et vous devez transmettre le paramètre --tac-url.

--help all, -h all

Utilisez le paramètre --help all pour afficher l'intégralité de l'aide et le paramètre -h all pour une version abrégée. Les exemples ci-dessous capturent la sortie dans un fichier texte pour référence ultérieure.

<tomcat_path>\webapps\org.talend.administrator\WEB-INF\classes>MetaServletCaller.bat 
--tac-url=http://localhost:8080/org.talend.administrator/ -help all > tac-help.txt

<tomcat_path>\webapps\org.talend.administrator\WEB-INF\classes>MetaServletCaller.bat 
--tac-url=http://localhost:8080/org.talend.administrator/ -h > tac-help-short.txt

runTask

Exécute une tâche en fonction de son ID.

<tomcat_path>\webapps\org.talend.administrator\WEB-INF\classes>MetaServletCaller.bat 
--tac-url=http://localhost:8080/org.talend.administrator/ -help runTask
----------------------------------------------------------
  Command: runTask
----------------------------------------------------------
Description             : Allows to run a task defined in Job conductor by its id. 
Mode can be 'asynchronous' or 'synchronous'
Requires authentication : true
Since                   : 4.2
Sample                  :
{
  "actionName": "runTask",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "jvmParams": [
    "-Xmx256m",
    "-Xms64m"
  ],
  "mode": "synchronous",
  "taskId": 1
}

Pour exécuter une tâche, vous devez connaître sa valeur de taskId générée par le système. Cette information peut être récupérée en exécutant la commande getTaskIdByName.

getTaskIdByName

Obtient l'ID correspondant de la tâche en recherchant sa valeur de taskName.

<tomcat_path>\webapps\org.talend.administrator\WEB-INF\classes>MetaServletCaller.bat --tac
-url=http://localhost:8080/org.talend.administrator/ -help getTaskIdByName
----------------------------------------------------------
  Command: getTaskIdByName
----------------------------------------------------------
Description             : Get task id by given taskName
Requires authentication : true
Since                   : 5.1
Sample                  :
{
  "actionName": "getTaskIdByName",
  "authPass": "admin",
  "authUser": "admin@company.com",
  "taskName": "task1"
}

Cette page vous a-t-elle aidé ?

Si vous rencontrez des problèmes sur cette page ou dans son contenu – une faute de frappe, une étape manquante ou une erreur technique – faites-le-nous savoir.

Laissez vos commentaires ici

API de la MetaServlet de Talend Administration Center