Pianificare job di monetizzazione

Stai visualizzando la documentazione di Apigee Edge.
Consulta la documentazione di Apigee X. info

Panoramica dei job pianificati

La monetizzazione fornisce uno scheduler di job e un insieme di job pre-pianificati per essere eseguiti in orari designati.

La tabella seguente elenca i job pianificati forniti dalla monetizzazione e gli orari in cui sono programmati per l'esecuzione (tutti gli orari elencati sono in formato UTC). Viene elencato anche il trigger per ogni job.

Oltre ai job elencati sopra, esistono job che puoi attivare tramite le notifiche di eventi, come indicato nella tabella seguente. Per ulteriori informazioni, vedi Configurare le notifiche.

Gestione della pianificazione dei job di monetizzazione utilizzando l'API

Le sezioni seguenti descrivono come gestire la pianificazione dei job di monetizzazione utilizzando l'API:

• Configurare i trigger
• Creazione di espressioni cron
• Visualizzare i job pianificati utilizzando l'API
• Aggiornamento dei job pianificati utilizzando l'API
• Disattivazione e riattivazione di un job programmato utilizzando l'API

Per saperne di più sulle API descritte in questa sezione, consulta Scheduled jobs nel riferimento API.

Configurazione dei trigger

Lo scheduler si basa sui trigger per eseguire i job. Un job programmato viene eseguito quando viene attivato il trigger associato. Le proprietà di un trigger configurano l'esecuzione del job e, impostando il valore di queste proprietà, puoi controllare le caratteristiche dell'esecuzione del job, ad esempio quando e con quale frequenza viene eseguito un job.

I due tipi più comuni di attivatori sono gli attivatori cron e gli attivatori semplici. Un trigger cron ha una proprietà cronExpression che specifica una pianificazione delle esecuzioni. Un trigger semplice non ha una proprietà cronExpression; devi specificare startTime per indicare quando il trigger entra in vigore e facoltativamente endTime.

Le proprietà del trigger sono le seguenti (tutti gli orari elencati sono in formato UTC):

Creazione di espressioni cron

Un'espressione cron è una stringa composta da sei o sette campi separati da spazi vuoti. L'espressione rappresenta un insieme di orari, in genere come pianificazione per eseguire una routine. Le espressioni cron specificate nella proprietà cronExpression di un attivatore vengono utilizzate per pianificare l'esecuzione dell'attivatore.

Dove:

I caratteri speciali sono definiti come segue:

Ecco alcuni esempi di espressioni cron (tutti gli orari elencati sono in UTC):

Visualizzazione dei job pianificati utilizzando l'API

Puoi visualizzare tutti i job attualmente pianificati inviando una richiesta GET a /triggers?orgid={org_name}.

Ad esempio:

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

Di seguito è riportato un esempio di risposta:

[ {
  "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
},
...
]

Puoi anche visualizzare un job programmato specifico inviando una richiesta GET a /triggers/{trig_id}, dove {trig_id} è l'identificazione del trigger del job, come descritto in Panoramica dei job programmati. Ad esempio:

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

Di seguito è riportato un esempio di risposta:

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

Aggiornamento dei job pianificati utilizzando l'API

Puoi aggiornare un job programmato modificando le proprietà del relativo trigger. Ad esempio, potresti dover modificare la pianificazione dell'esecuzione del trigger.

Per i job di attivazione cron (ovvero i job che includono un valore di espressione cron), puoi modificare solo i valori delle proprietà cronExpression e enabled. Le altre modifiche vengono ignorate. Per i job che non specificano un valore di espressione cron, puoi modificare altre proprietà come startTime o priority.

Per aggiornare un job programmato, invia una richiesta PUT a /triggers/{trig_id}, dove {trig_id} è l'identificazione del trigger del job, come descritto in Panoramica dei job programmati. Quando esegui l'aggiornamento, devi specificare nel corpo della richiesta le impostazioni aggiornate e l'ID del trigger.

Ad esempio, la seguente richiesta aggiorna l'espressione cron per il job di rinnovo del piano tariffario per i nuovi sviluppatori in modo che venga eseguito ogni giorno alle 05:00 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

Disattivazione e riattivazione di un job programmato utilizzando l'API

Per disabilitare un job programmato, imposta il valore della proprietà enabled del relativo trigger su false. Ad esempio:

$ 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

Per riattivare un job disattivato, imposta il valore della proprietà enabled del relativo trigger su true.

Passaggi successivi

Ti consigliamo di eseguire periodicamente una nuova sincronizzazione con la monetizzazione della tua organizzazione e di tutti gli sviluppatori, le applicazioni e i prodotti che hai creato utilizzando Edge API Services. Scopri come in Sincronizzare i dati di Apigee Edge con la monetizzazione.