Programar jobs de monetização

Esta é a documentação do Apigee Edge.
Acesse Documentação da Apigee X. informações

Visão geral dos jobs programados

A monetização oferece um programador de tarefas e um conjunto de tarefas pré-agendadas para execução em horários específicos.

A tabela abaixo lista os jobs pré-agendados fornecidos por monetização e os horários em que eles são programado para execução (todos os horários listados estão em UTC). Também está listado o gatilho de cada job.

Além das tarefas listadas acima, há tarefas que podem ser habilitadas por meio de eventos conforme listado na tabela a seguir. Para mais informações, consulte Configurar notificações.

Como gerenciar a programação do job de monetização usando a API

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

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

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

Como configurar acionadores

O programador depende de gatilhos para executar jobs. Um job programado é executado quando os jobs é executado. As propriedades de um gatilho definem a execução do job e definem dessas propriedades, é possível controlar as características da execução do job. Por exemplo, quando um job é executado e com que frequência.

Os dois tipos mais comuns de gatilhos são acionadores cron e acionadores simples e gatilhos de detecção. Um gatilho cron tem uma propriedade cronExpression que especifica uma programação de execução. Um acionador simples não tem uma propriedade cronExpression. você especificar startTime para indicar quando o gatilho vai entrar em vigor; opcionalmente, endTime.

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

Como criar expressões cron

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

Em que:

Os caracteres especiais são definidos da seguinte maneira:

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

Como visualizar jobs programados usando a API

É possível visualizar todos os jobs programados emitindo 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 visualizar um job específico programado emitindo uma solicitação GET para /triggers/{trig_id}, em que {trig_id} é a identificação do job conforme descrito na 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
}

Como atualizar jobs programados usando a API

É possível atualizar um job programado alterando as propriedades do acionador. Por exemplo, talvez seja necessário alterar a programação de execução do gatilho.

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

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

Por exemplo, a solicitação a seguir atualiza a expressão cron para o Novo plano de preços do desenvolvedor Job de renovação 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 falsa. 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 verdade.

Próximas etapas

É aconselhável sincronizar periodicamente com a monetização de sua organização e de quaisquer desenvolvedores, aplicativos e produtos que você criou usando os serviços da API Edge. Saiba como em Sincronizar Dados do Apigee Edge com monetização.