Planifier des tâches de monétisation

Vous consultez la documentation Apigee Edge.
Accédez à la documentation Apigee X.

Présentation des jobs planifiés

La monétisation fournit un planificateur de tâches et un ensemble de tâches prévues pour s'exécuter à des heures spécifiques.

Le tableau ci-dessous liste les jobs prévus fournis par la monétisation et les heures auxquelles ils sont programmés pour s'exécuter (toutes les heures indiquées sont en UTC). Le déclencheur de chaque job est également indiqué.

En plus des jobs listés ci-dessus, vous pouvez activer des jobs via les notifications d'événements, comme indiqué dans le tableau suivant. Pour en savoir plus, consultez Configurer les notifications.

Gérer le calendrier des tâches de monétisation à l'aide de l'API

Les sections suivantes décrivent comment gérer la planification des tâches de monétisation à l'aide de l'API :

• Configurer des déclencheurs
• Créer des expressions Cron
• Afficher les jobs planifiés à l'aide de l'API
• Mettre à jour les jobs planifiés à l'aide de l'API
• Désactiver et réactiver un job planifié à l'aide de l'API

Pour en savoir plus sur les API décrites dans cette section, consultez Tâches planifiées dans la documentation de référence de l'API.

Configurer les déclencheurs

Le planificateur s'appuie sur des déclencheurs pour exécuter les jobs. Un job planifié s'exécute lorsque son déclencheur associé s'exécute. Les propriétés d'un déclencheur configurent l'exécution du job. En définissant la valeur de ces propriétés, vous pouvez contrôler les caractéristiques de l'exécution du job, comme le moment et la fréquence d'exécution.

Les deux types de déclencheurs les plus courants sont les déclencheurs cron et les déclencheurs simples. Un déclencheur cron possède une propriété cronExpression qui spécifie un calendrier d'exécution. Un déclencheur simple n'a pas de propriété cronExpression. Vous spécifiez startTime pour indiquer quand le déclencheur prend effet, et éventuellement endTime.

Voici les propriétés du déclencheur (toutes les heures indiquées sont en UTC) :

Créer des expressions Cron

Une expression Cron correspond à une chaîne composée de six ou sept champs séparés par des espaces blancs. L'expression représente un ensemble d'heures, généralement sous la forme d'une programmation pour exécuter une routine. Les expressions Cron spécifiées dans la propriété cronExpression d'un déclencheur sont utilisées pour planifier l'exécution de ce déclencheur.

Où :

Les caractères spéciaux sont définis comme suit :

Voici quelques exemples d'expressions cron (toutes les heures indiquées sont en temps UTC) :

Afficher les jobs planifiés à l'aide de l'API

Vous pouvez afficher tous les jobs actuellement programmés en envoyant une requête GET à /triggers?orgid={org_name}.

Exemple :

$ curl -H "Accept:application/json" -X GET \ "http://localhost:8080/v1/mint/triggers?orgid={org_name}" \ -u email:password

Voici un exemple de réponse :

[ {
  "createdDate" : 1457924378176,
  "cronExpression" : "3 0 0 * * ?",
  "enabled" : true,
  "group" : "management-server",
  "id" : "MINT.RESET_DEVELOPER_RATE_PLAN_COUNTER@@@management-server@@@DEFAULT@@@management-server@@@DEFAULT",
  "jobId" : "MINT.RESET_DEVELOPER_RATE_PLAN_COUNTER@@@management-server",
  "name" : "MINT.RESET_DEVELOPER_RATE_PLAN_COUNTER@@@management-server@@@DEFAULT",
  "priority" : "1",
  "suiteId" : "DEFAULT",
  "triggerDataMap" : {
    "custom_lock_key" : "mint.scheduler.__ORG_ID__.resetdeveloperrateplancounter@@@management"
  },
  "updatedDate" : 1457924378176
}, {
  "createdDate" : 1457924378014,
  "cronExpression" : "",
  "enabled" : true,
  "group" : "management-server",
  "id" : "MINT.ADHOC_NOTIFY@@@management-server@@@DEFAULT@@@management-server@@@DEFAULT",
  "jobId" : "MINT.ADHOC_NOTIFY@@@management-server",
  "name" : "MINT.ADHOC_NOTIFY@@@management-server@@@DEFAULT",
  "priority" : "4",
  "startTime" : "1372916749000",
  "suiteId" : "DEFAULT",
  "triggerDataMap" : {
    "custom_lock_key" : "mint.scheduler.__ORG_ID__.adhocnotify@@@management"
  },
  "updatedDate" : 1457924378014
}, {
  "createdDate" : 1457924377877,
  "cronExpression" : "0 20 1 * * ?",
  "enabled" : true,
  "group" : "management-server",
  "id" : "MINT.CHARGE_DAILY@@@management-server@@@DEFAULT@@@management-server@@@DEFAULT",
  "jobId" : "MINT.CHARGE_DAILY@@@management-server",
  "name" : "MINT.CHARGE_DAILY@@@management-server@@@DEFAULT",
  "priority" : "1",
  "suiteId" : "DEFAULT",
  "triggerDataMap" : {
    "custom_lock_key" : "mint.scheduler.__ORG_ID__.chargedaily@@@management"
  },
  "updatedDate" : 1457924377877
},
...
]

Vous pouvez également afficher un job planifié spécifique en envoyant une requête GET à /triggers/{trig_id}, où {trig_id} est l'identifiant du déclencheur de job, comme décrit dans Présentation des jobs planifiés. Exemple :

$ curl -X GET \ "http://localhost:8080/v1/mint/triggers/MINT.RENEW_DEV_RATEPLAN@@@management-server@@@DEFAULT@@@management-server@@@DEFAULT" \ -u email:password

Voici un exemple de réponse :

{
    "createdDate" : 1457924377925,
    "cronExpression" : "0 20 2 * * ?",
    "enabled" : true,
    "group" : "management-server",
    "id" : "MINT.RENEW_DEV_RATEPLAN@@@management-server@@@DEFAULT@@@management-server@@@DEFAULT",
    "jobId" : "MINT.RENEW_DEV_RATEPLAN@@@management-server",
    "name" : "MINT.RENEW_DEV_RATEPLAN@@@management-server@@@DEFAULT",
    "priority" : "1",
    "suiteId" : "DEFAULT",
    "triggerDataMap" : {
        "custom_lock_key" : "mint.scheduler.__ORG_ID__.renewydevrateplan@@@management"
    },
    "updatedDate" : 1457924377925
}

Mettre à jour les jobs planifiés à l'aide de l'API

Vous pouvez mettre à jour un job planifié en modifiant les propriétés de son déclencheur. Par exemple, vous devrez peut-être modifier le calendrier d'exécution du déclencheur.

Pour les jobs de déclencheur Cron (c'est-à-dire les jobs qui incluent une valeur d'expression Cron), vous ne pouvez modifier que les valeurs des propriétés cronExpression et "enabled". Les autres modifications sont ignorées. Pour les jobs qui ne spécifient pas de valeur d'expression cron, vous pouvez modifier d'autres propriétés telles que startTime ou priority.

Pour mettre à jour un job planifié, envoyez une requête PUT à /triggers/{trig_id}, où {trig_id} correspond à l'identification du déclencheur de job, comme décrit dans Présentation des jobs planifiés. Lorsque vous effectuez la mise à jour, vous devez spécifier dans le corps de la requête les paramètres mis à jour et l'ID du déclencheur.

Par exemple, la requête suivante met à jour l'expression cron du job de renouvellement du forfait Nouveau développeur pour qu'il s'exécute tous les jours à 5h UTC :

$ curl -H "Content-Type: application/json" -X PUT -d \
 '{
    "cronExpression" : "0 0 5 * * ?",
    "enabled" : true,
    "group" : "management-server", 
    "id" : "MINT.RENEW_DEV_RATEPLAN@@@management-server@@@DEFAULT@@@management-server@@@DEFAULT",
    "jobId" : "MINT.RENEW_DEV_RATEPLAN@@@management-server",
    "name" : "MINT.RENEW_DEV_RATEPLAN@@@management-server@@@DEFAULT",
    "priority" : "1",
    "suiteId" : "DEFAULT",
    "triggerDataMap" : {
        "custom_lock_key" : "mint.scheduler.__ORG_ID__.renewydevrateplan@@@management"
    },
}' \
https://localhost:8080/v1/mint/triggers/MINT.RENEW_DEV_RATEPLAN@@@management-server@@@DEFAULT@@@management-server@@@DEFAULT
\
-u email:password

Désactiver et réactiver un job planifié à l'aide de l'API

Pour désactiver un job planifié, définissez la valeur de la propriété enabled de son déclencheur sur "false". Exemple :

$ curl -H "Content-Type: application/json" -X PUT -d \
 '{
    "cronExpression" : "0 0 5 * * ?",
    "enabled" : false,
    "group" : "management-server",
    "id" : "MINT.RENEW_DEV_RATEPLAN@@@management-server@@@DEFAULT@@@management-server@@@DEFAULT",
    "jobId" : "MINT.RENEW_DEV_RATEPLAN@@@management-server",
    "name" : "MINT.RENEW_DEV_RATEPLAN@@@management-server@@@DEFAULT",
    "priority" : "1",
    "suiteId" : "DEFAULT",
    "triggerDataMap" : {
        "custom_lock_key" : "mint.scheduler.__ORG_ID__.renewydevrateplan@@@management"
    },
}' \
https://localhost:8080/v1/mint/triggers/MINT.RENEW_DEV_RATEPLAN@@@management-server@@@DEFAULT@@@management-server@@@DEFAULT
\
-u email:password

Pour réactiver une tâche désactivée, définissez la valeur de la propriété enabled de son déclencheur sur "true".

Étapes suivantes

Il est conseillé de resynchroniser régulièrement la monétisation avec votre organisation, ainsi qu'avec les développeurs, applications et produits que vous avez créés à l'aide des services d'API Edge. Pour en savoir plus, consultez Synchroniser les données Apigee Edge avec la monétisation.