API de la MetaServlet de Talend Administration Center - 6.4

API de Talend Administration Center

author
Talend Documentation Team
EnrichVersion
6.4
EnrichProdName
Talend Big Data
Talend Big Data Platform
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Real-Time Big Data Platform
task
Administration et monitoring > Gestion des projets
Administration et monitoring > Gestion des utilisateurs
Administration et monitoring > Monitoring des exécutions
Déploiement > Ordonnancement > Ordonnancement de Jobs
EnrichPlatform
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 sont invoquées via une requête GET HTTP. Tous les paramètres de l'opération sont encodés en tant que seul paramètre sans nom, encodé en base-64 pour la requête GET.

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"
}