Planifier des tâches de monétisation

<ph type="x-smartling-placeholder"></ph> Vous consultez la documentation Apigee Edge.
Accédez à la page Documentation sur Apigee X. En savoir plus

Présentation des jobs planifiés

La monétisation fournit un planificateur de jobs et un ensemble de jobs préprogrammés pour s'exécuter à à l'heure indiquée.

Le tableau ci-dessous liste les missions préprogrammées fournies par la monétisation et les heures auxquelles elles sont (toutes les heures indiquées sont exprimées en temps UTC). Le déclencheur pour chaque tâche est également indiqué.

En plus des jobs listés ci-dessus, vous pouvez activer des jobs via des événements des notifications, 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 le calendrier des tâches de monétisation à l'aide de l'API:

• Configurer des déclencheurs
• Créer des expressions Cron
• Afficher les tâches planifiées à l'aide de l'API
• Mettre à jour des jobs planifiés à l'aide de l'API
• Désactiver et réactiver une tâche planifiée à l'aide du API

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

Configurer les déclencheurs

L'ordonnanceur s'appuie sur des déclencheurs pour exécuter des jobs. Un job planifié s'exécute lorsqu'il est associé du déclencheur s'exécute. Les propriétés d'un déclencheur configurent l'exécution du job et, en définissant le paramètre valeur de ces propriétés, vous pouvez contrôler les caractéristiques d'exécution du job, par exemple lorsqu'un job exécute et à quelle fréquence.

Les deux types de déclencheurs les plus courants sont les déclencheurs Cron et les déclencheurs simples déclencheurs. Un déclencheur Cron possède une propriété cronExpression qui spécifie une du calendrier d'exécution. Un déclencheur simple ne possède pas de propriété cronExpression. vous spécifier startTime pour indiquer à quel moment le déclencheur entre en vigueur ; et éventuellement endTime.

Les propriétés du déclencheur sont les suivantes (toutes les heures indiquées sont exprimées en temps UTC):

Créer des expressions Cron

Une expression Cron est une chaîne composée de six ou sept champs séparés par un espace. La représente un ensemble de durées, généralement sous la forme d'une programmation d'exécution d'une routine. cron Les expressions 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 exprimées en temps UTC):

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

Vous pouvez afficher toutes les tâches actuellement planifiées en envoyant une demande 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 une tâche planifiée spécifique en envoyant une demande GET à /triggers/{trig_id}, où {trig_id} est l'identification de la tâche. comme décrit dans la section 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 des jobs planifiés à l'aide de l'API

Vous pouvez mettre à jour une tâche planifiée 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 tâches de déclencheur Cron (c'est-à-dire les tâches qui incluent une valeur d'expression Cron), vous ne pouvez modifier les valeurs de cronExpression et les propriétés activées. Les autres modifications sont sont ignorées. Pour les tâches qui ne spécifient pas de valeur d'expression Cron, vous pouvez modifier d'autres propriétés comme startTime ou priority.

Pour mettre à jour une tâche planifiée, envoyez une requête PUT à /triggers/{trig_id}, où {trig_id} est l'identification du déclencheur de tâche, comme décrit dans la présentation des tâches planifiées. Lorsque vous effectuez la mise à jour, vous devez spécifier dans 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 pour le nouveau plan tarifaire pour les développeurs Tâche de renouvellement à exécuter 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 une tâche planifiée à l'aide de l'API

Pour désactiver une tâche planifiée, 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 les paramètres de monétisation développeurs, applications et produits que vous avez créés à l'aide des services d'API Edge. Découvrez comment faire dans Synchroniser Données Apigee Edge avec monétisation