Programar jobs de monetização

Você está lendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

Visão geral dos jobs programados

A monetização oferece um programador de jobs e um conjunto de jobs pré-programados para serem executados em horários designados.

A tabela abaixo lista os jobs pré-programados fornecidos pela monetização e os horários em que eles são executados (todos os horários listados estão em UTC). O gatilho de cada job também é listado.

Além dos jobs listados acima, há outros que podem ser ativados por notificações de eventos, conforme mostrado na tabela a seguir. Para mais informações, consulte Configurar notificações.

Gerenciar a programação de jobs de monetização usando a API

As seções a seguir descrevem como gerenciar a programação de jobs de monetização usando a API:

• Como configurar gatilhos
• Como criar expressões cron
• Como visualizar jobs programados usando a API
• Atualizar jobs programados usando a API
• Como desativar e reativar um job programado usando a API

Para mais informações sobre as APIs descritas nesta seção, consulte Jobs programados na referência da API.

Como configurar acionadores

O programador depende de gatilhos para executar jobs. Um job programado é executado quando o acionador associado a ele é executado. As propriedades de um gatilho configuram a execução do job. Ao definir o valor dessas propriedades, é possível controlar características da execução do job, como quando e com que frequência ele é executado.

Os dois tipos mais comuns de acionadores são acionadores cron e acionadores simples. Um gatilho cron tem uma propriedade cronExpression que especifica uma programação de execução. Um gatilho simples não tem uma propriedade cronExpression. Você especifica o startTime para indicar quando o gatilho entra em vigor e, opcionalmente, o endTime.

As propriedades do gatilho são as seguintes (todos os horários listados estão em UTC):

Como criar expressões cron

Uma expressão cron é uma string que contém seis ou sete campos separados por espaços em branco. A expressão representa um conjunto de horários, normalmente como uma programação para executar uma rotina. As expressões cron especificadas na propriedade cronExpression de um acionador são usadas para programar a execução dele.

Em que:

Os caracteres especiais são definidos da seguinte maneira:

Confira alguns exemplos de expressões cron (todos os horários listados estão em UTC):

Como visualizar jobs programados usando a API

Para conferir todos os jobs programados, envie uma solicitação GET para /triggers?orgid={org_name}.

Exemplo:

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

Veja a seguir um exemplo de resposta:

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

Também é possível conferir um job programado específico enviando uma solicitação GET para /triggers/{trig_id}, em que {trig_id} é a identificação do acionador do job conforme descrito em Visão geral dos jobs programados. Exemplo:

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

Veja a seguir um exemplo de resposta:

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

Atualizar jobs programados usando a API

Para atualizar um job programado, mude as propriedades do gatilho dele. Por exemplo, talvez seja necessário mudar a programação de execução do gatilho.

Para jobs de acionamento do cron (ou seja, jobs que incluem um valor de expressão cron), só é possível mudar os valores das propriedades cronExpression e "enabled". Outras mudanças são ignoradas. Para jobs que não especificam um valor de expressão cron, é possível mudar outras propriedades, como startTime ou priority.

Para atualizar um job programado, envie uma solicitação PUT para /triggers/{trig_id}, em que {trig_id} é a identificação do acionador de jobs, conforme descrito em Visão geral dos jobs programados. Ao fazer a atualização, especifique no corpo da solicitação as configurações atualizadas e o ID do gatilho.

Por exemplo, a solicitação a seguir atualiza a expressão cron para o job de renovação do plano de tarifas para novos desenvolvedores para ser executado todos os dias às 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

Como desativar e reativar um job programado usando a API

Para desativar um job programado, defina o valor da propriedade enabled do gatilho como false. Exemplo:

$ 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

Para reativar um job desativado, defina o valor da propriedade enabled do gatilho como true.

Próximas etapas

É recomendável resincronizar periodicamente com a monetização sua organização e todos os desenvolvedores, aplicativos e produtos que você criou usando os serviços de API do Edge. Saiba como em Sincronizar dados do Apigee Edge com a monetização.