Appliquer un ordonnancement à une tâche - Cloud

Guide d'utilisation des API Talend Cloud
Version
Cloud
Language
Français
Product
Talend Cloud
Module
Talend API Designer
Talend API Tester
Talend Data Preparation
Talend Data Stewardship
Talend Management Console
Content
Création et développement > Création d'APIs
Création et développement > Test d'API
Last publication date
2024-04-04

Associez, ou, en d'autres mots, attribuez votre ordonnancement à une tâche, révoquez cette association si besoin et éventuellement supprimez l'ordonnancement.

Un ordonnancement peut être associé à une tâche ou un plan uniquement. Vous devez désaffecter l'ordonnancement avant de l'attribuer à une autre tâche ou à un autre plan. Si une autre tâche ou un autre plan doit utiliser cet ordonnancement en même temps, dupliquez-le comme expliqué dans la section suivante.

Avant de commencer

  • Générez des jetons d'accès :

    Une fois généré, un jeton de compte de service expire après 30 minutes. S'il expire, générez un nouveau jeton à l'aide de la méthode POST sur l'endpoint https://api.<env>.cloud.talend.com/security/oauth/token. Pour plus d'informations concernant la génération de ce jeton, consultez Générer un jeton de compte de service.

  • Vous devez connaître l'ID de l'ordonnancement pour lequel vous souhaitez simuler des événements.
  • Vous devez connaître l'ID de la tâche à laquelle associer l'ordonnancement.
    Dans Talend Management Console, cet ID est affiché sur la page dédiée de la tâche. Par exemple :
    ID de la tâche dans la page de la tâche.
    Vous pouvez également obtenir l'ID des tâches via la requête d'API suivante : 
    method: GET
endpoint: https://api.<env>.cloud.talend.com/processing/executables/tasks
headers: {
          "Content-Type": "application/json",
          "Authorization": "Bearer <your_personal_or_service_account_access_token>"
          }
query parameters: {
          "workspaceId": "id_of_the_workspace_of_the_task_to_be_updated"
                  }
  • L'utilisateur·trice de ce compte de service doit avoir le rôle TMC_OPERATOR et l'autorisation EXECUTOR pour l'espace de travail auquel appartient la tâche à mettre à jour.

Procédure

  1. Émettez la requête suivante pour associer votre ordonnancement à une tâche. Ainsi, l'exécution de la tâche sera déclenchée selon l'ordonnancement.

    Exemple

    Les déclencheurs de cet ordonnancement remplacent les déclencheurs qui existent sur la tâche. Si vous souhaitez conserver les déclencheurs de la tâche, définissez les mêmes déclencheurs dans l'ordonnancement à associer, comme expliqué dans les sections précédentes, avant de commencer cette association.

    Ainsi, les nouveaux et les anciens déclencheurs sont ajoutés à la tâche avec l'ordonnancement.

    method: PUT
endpoint: https://api.<env>.cloud.talend.com/orchestration/executables/tasks/<taskId>/schedule
headers: {
      "Content-Type": "application/json",
      "Authorization": "Bearer <your_personal_access_token_or_service_account_token>"
          }
payload: {
       "scheduleId": "schedule_id"
          }
  2. Émettez l'appel d'API suivant pour révoquer l'association entre cet ordonnancement et la tâche. Cette étape est obligatoire si vous devez supprimer cet ordonnancement, car un ordonnancement peut être supprimé uniquement lorsqu'il est orphelin.

    Exemple

    method: DELETE
endpoint: https://api.<env>.cloud.talend.com/orchestration/executables/tasks/<taskId>/schedule
headers: {
      "Content-Type": "application/json",
      "Authorization": "Bearer <your_personal_access_token_or_service_account_token>"
          }
payload: N/A

    Cette requête désaffecte l'ordonnancement de votre tâche. Il est à présent orphelin et peut être supprimé.

    Si vous souhaitez connaître les détails de cet ordonnancement, émettez la requête d'API suivante :
    method: GET
endpoint: https://api.<env>.cloud.talend.com/orchestration/schedules/<scheduleId>
headers: {
      "Content-Type": "application/json",
      "Authorization": "Bearer <your_personal_access_token_or_service_account_token>"
          }
payload: N/A
    L'autorisation VIEW sur l'espace de travail auquel appartient cette tâche est requise.
  3. Maintenant que cet ordonnancement est orphelin, supprimez-le à l'aide de la requête d'API suivante :

    Exemple

    method: DELETE
endpoint: https://api.<env>.cloud.talend.com/orchestration/schedules/<scheduleId>
headers: {
      "Content-Type": "application/json",
      "Authorization": "Bearer <your_personal_access_token_or_service_account_token>"
          }
payload: N/A

Résultats

L'ordonnancement est supprimé.