Déclencheur Cloud Scheduler

Le déclencheur Cloud Scheduler vous permet de planifier vos exécutions d'intégration sur des périodes définies ou à intervalles réguliers dans plusieurs régions.

Les déclencheurs Cloud Scheduler s'appuient sur les services Cloud Scheduler pour fournir un planificateur de jobs Cron entièrement géré pour l'entreprise au sein d'Apigee Integration. Grâce à ce déclencheur, vous pouvez désormais gérer tous vos jobs Cron créées dans votre intégration, à la fois depuis l'interface utilisateur d'Apigee Integration et depuis le tableau de bord de Cloud Scheduler. De plus, le déclencheur Cloud Scheduler vous permet également de déployer des jobs Cron interrégionaux pour planifier vos exécutions d'intégration.

Par exemple, si vous avez provisionné votre intégration dans us-central1, vous pouvez utiliser le déclencheur Cloud Scheduler pour déployer un job Cron dans asia-east1 (ou toute autre région Google Cloud prise en charge pour Cloud Scheduler) afin d'appeler le point de terminaison de votre intégration dans us-central1.

Avant de commencer

Assurez-vous d'effectuer les tâches suivantes dans votre projet Google Cloud avant de configurer le déclencheur Cloud Scheduler :

  1. Activez l'API Cloud Scheduler (cloudscheduler.googleapis.com).

    Activer l'API Cloud Scheduler

  2. Confirmez que vous disposez d'un compte de service Google avec le rôle Demandeur Apigee Integration attribué. Si vous n'avez pas de compte de service, vous devez en créer un et lui attribuer le rôle Demandeur Apigee Integration.

    Pour en savoir plus sur la création et la gestion des comptes de service, consultez la section Créer et gérer des comptes de service.

    Pour en savoir plus sur les rôles prédéfinis pour Apigee Integration, consultez la page Rôles IAM prédéfinis.

Ajouter le déclencheur Cloud Scheduler

Pour ajouter un déclencheur Cloud Scheduler à votre intégration, procédez comme suit :

  1. Dans l'interface utilisateur Apigee, sélectionnez votre organisation Apigee.
  2. Cliquez sur Développer > Intégrations.
  3. Sélectionnez une intégration existante ou créez-en une en cliquant sur Créer une intégration.

    Si vous créez une intégration :

    1. Saisissez un nom et une description dans la boîte de dialogue Créer une intégration.
    2. Dans la liste des régions compatibles, sélectionnez une région pour l'intégration.
    3. Cliquez sur Créer.

    La page de conception d'intégration s'affiche.

  4. Dans la barre de navigation de la page de conception d'intégration, cliquez sur +Ajouter une tâche ou un déclencheur > Déclencheurs pour afficher la liste des déclencheurs disponibles.
  5. Cliquez sur l'élément Déclencheur Cloud Scheduler et placez-le dans l'éditeur d'intégrations.

Configurer le déclencheur Cloud Scheduler

Pour configurer un déclencheur Cloud Scheduler, procédez comme suit :

  1. Cliquez sur l'élément Déclencheur Cloud Scheduler dans l'éditeur d'intégrations pour ouvrir le volet de configuration du déclencheur.

    Spécifiez la planification du déclencheur Cloud Scheduler à l'aide de l'une des options suivantes :

    • Basic : utilisez l'interface utilisateur pour configurer la planification du job Cron.
    • Advanced : utilisez une expression unix-cron pour configurer la planification du job Cron.
  2. (Pour l'option "Basic") Sélectionnez l'onglet Basic et procédez comme suit dans les champs indiqués :
    1. Times : sélectionnez les intervalles de temps auxquels l'intégration doit s'exécuter.
      • Run at a specific time : sélectionnez cette option pour exécuter l'intégration à un moment précis.
      • Repeat by the hour : sélectionnez cette option pour exécuter l'intégration de façon répétée par heure.
      • Repeat by the minute : sélectionnez cette option pour exécuter l'intégration de façon répétée selon le nombre de minutes spécifié.
    2. Days : sélectionnez les jours où l'intégration doit être exécutée. Vous pouvez choisir d'exécuter l'intégration tous les jours, certains jours de la semaine ou un jour spécifique du mois.
    3. Months : sélectionnez le ou les mois dans lesquels l'intégration doit être exécutée. Vous pouvez choisir d'exécuter l'intégration tous les mois ou à des mois spécifiques.
  3. (Pour l'option "Advanced") Sélectionnez l'onglet Advanced et spécifiez la planification du job Cron à l'aide d'une expression Cron.

    L'expression Cron comporte cinq valeurs qui doivent être spécifiées dans l'ordre suivant :

    1. minute (0-59)
    2. heure (0-23)
    3. jour du mois (1-31)
    4. mois, exprimé en l'une des valeurs suivantes :
      • Numéro 1-12
      • Une abréviation de trois lettres correspondant à un mois (par exemple, Jan, Feb, Mar)
    5. Jour de la semaine, exprimé en l'une des valeurs suivantes :
      • Nombre compris entre 0 et 6, commençant par dimanche en tant que 0
      • Abréviation à trois lettres pour le jour (par exemple, Mon, Tue, Wed)

    Par exemple, pour exécuter l'intégration le premier jour de chaque mois, utilisez l'expression Cron * * 1 * *.

    Pour en savoir plus, consultez la section Configurer des planifications de jobs Cron.

  4. Region : sélectionnez la région dans laquelle votre job Cloud Scheduler sera déployé.
  5. Service account email : saisissez l'adresse e-mail du compte de service Google créé.

Sortie du déclencheur

Pour chaque déclencheur Cloud Scheduler configuré et publié dans votre version d'intégration, Apigee Integration crée un job Cloud Scheduler dans votre projet Google Cloud.

Un job Cloud Scheduler est créée à l'aide de la convention d'attribution de noms suivante pour éviter toute erreur de duplication de jobs : 

    INTEGRATION_NAME__VINTEGRATION_VERSION__CLOUD_SCHEDULER_TRIGGER_NUMBER

Exemple : DemoIntegration__V1__1

Journaux de déclencheurs

Un déclencheur Cloud Scheduler génère des journaux au début et à la fin de chaque exécution d'intégration. Vous pouvez afficher les journaux du déclencheur Cloud Scheduler sur la page Explorateur de journaux Cloud Logging:

  1. Dans la console Google Cloud, accédez à la page Cloud Scheduler.

    Accéder à Cloud Scheduler

  2. Localisez votre job Cloud Scheduler et cliquez sur Afficher dans la colonne Journaux.

    La page Explorateur de journaux Cloud Logging apparaît et affiche les journaux générés par le déclencheur Cloud Scheduler.

Modifier un déclencheur Cloud Scheduler

Apigee Integration

Pour modifier votre déclencheur Cloud Scheduler depuis Apigee Integration, procédez comme suit :

  1. Dans l'interface utilisateur Apigee, sélectionnez votre organisation Apigee.
  2. Cliquez sur Développer > Intégrations.
  3. Sélectionnez l'intégration que vous souhaitez modifier.
  4. Dans l'éditeur d'intégrations, cliquez sur la liste déroulante des versions et sélectionnez la version d'intégration contenant le déclencheur Cloud Scheduler que vous souhaitez modifier.
  5. Annulez la publication et activez les modifications si la version d'intégration sélectionnée est publiée (état actif).
  6. Cliquez sur l'élément Déclencheur Cloud Scheduler dans l'éditeur d'intégrations pour ouvrir le volet de configuration du déclencheur.
  7. Modifiez les configurations de jobs Cloud Scheduler comme vous le souhaitez.

Cloud Scheduler

Vous pouvez modifier votre déclencheur Cloud Scheduler en modifiant la configuration de votre job Cloud Scheduler à partir de Cloud Scheduler :

  1. Dans la console Google Cloud, accédez à Cloud Scheduler.

    Accéder à Cloud Scheduler

  2. Sélectionnez le job Cloud Scheduler à modifier.
  3. Cliquez sur Modifier.
  4. Modifiez les configurations de jobs Cloud Scheduler comme vous le souhaitez.

Suspendre, reprendre et copier un job Cloud Scheduler

Apigee Integration ne prend pas en charge les opérations de mise en pause, de reprise et de copie pour un job Cloud Scheduler créée à l'aide du déclencheur Cloud Scheduler.

Le déclencheur Cloud Scheduler génère une erreur dans le volet de configuration du déclencheur si vous suspendez manuellement l'exécution d'un job Cloud Scheduler depuis Cloud Scheduler.

Pour en savoir plus sur les messages d'erreur liés au déclencheur Cloud Scheduler, consultez la section Résoudre les problèmes liés au déclencheur Cloud Scheduler. Pour savoir comment suspendre et reprendre un job Cron à l'aide de Cloud Scheduler, consultez la section Suspendre ou reprendre un job.

Supprimer un job Cloud Scheduler

Vous pouvez supprimer un job Cloud Scheduler depuis votre intégration dans Apigee Integration ou depuis Cloud Scheduler.

Apigee Integration

Pour supprimer un job Cloud Scheduler depuis Apigee Integration, procédez comme suit :

  1. Dans l'interface utilisateur Apigee, sélectionnez votre organisation Apigee.
  2. Cliquez sur Développer > Intégrations.
  3. Sélectionnez l'intégration que vous souhaitez modifier.
  4. Dans l'éditeur d'intégrations, cliquez sur la liste déroulante des versions et sélectionnez la version d'intégration contenant le déclencheur Cloud Scheduler que vous souhaitez supprimer.
  5. Annulez la publication de la version d'intégration sélectionnée.

    Le job Cloud Scheduler pour la version d'intégration correspondante est supprimé.

Cloud Scheduler

Pour supprimer un job Cloud Scheduler depuis Cloud Scheduler, procédez comme suit :

  1. Dans la console Google Cloud, accédez à Cloud Scheduler.

    Accéder à Cloud Scheduler

  2. Sélectionnez le job Cloud Scheduler à supprimer.
  3. Cliquez sur Supprimer.

    Le job Cloud Scheduler pour la version d'intégration correspondante est supprimé.

Bonnes pratiques

Il est recommandé d'annuler la publication des déclencheurs Cloud Scheduler lorsqu'ils ne sont plus nécessaires. Si vous laissez un déclencheur Cloud Scheduler redondant publié, celui-ci continue d'appeler automatiquement l'intégration, ce qui peut entraîner des frais supplémentaires.

Résoudre les problèmes liés au déclencheur Cloud Scheduler

Le tableau suivant décrit les erreurs que vous pouvez rencontrer dans le déclencheur Cloud Scheduler et les causes correspondantes.

Emplacement de l'erreur Occurrence d'erreur Message d'erreur Causes possibles Solution
Volet de configuration du déclencheur > Message d'erreur Lorsque le job Cloud Scheduler arrête l'exécution de votre intégration The configured Cloud Scheduler job CLOUD_SCHEDULER_JOB doesn’t exist. It might be deleted from your Google Cloud project. Le job Cloud Scheduler est supprimée à l'aide de Cloud Scheduler. Créez une nouvelle version d'intégration pour écraser votre job Cloud Scheduler existant.
The configured Cloud Scheduler job CLOUD_SCHEDULER_JOB is PAUSED. You must RESUME the job from your Google Cloud project. Le job Cloud Scheduler est suspendu à l'aide de Cloud Scheduler. Relancez le job Cloud Scheduler depuis Cloud Scheduler.
The configured Cloud Scheduler job CLOUD_SCHEDULER_JOB is DISABLED due to an internal system error. Consultez les journaux de déclencheurs pour identifier le problème. Créez une nouvelle version d'intégration pour écraser votre job Cloud Scheduler existant.
The configured Cloud Scheduler job CLOUD_SCHEDULER_JOB is in an UPDATE_FAILED state due to a failed CloudScheduler.UpdateJob operation. Le compte de service fourni ne dispose pas des autorisations IAM requises. Pour restaurer un job depuis cet état, relancez l'opération CloudScheduler.UpdateJob jusqu'à ce qu'une réponse positive soit reçue.
The last execution of the Cloud Scheduler job CLOUD_SCHEDULER_JOB failed due to CLOUD_SCHEDULER_JOB_ISSUE. Learn more. CLOUD_SCHEDULER_JOB_ISSUE N/A