Programa trabajos de monetización

Estás viendo la documentación de Apigee Edge.
Ir a la documentación de Apigee X. info

Descripción general de los trabajos programados

La monetización proporciona un programador de trabajos y un conjunto de trabajos que están programados previamente para ejecutarse en horarios designados.

En la siguiente tabla, se enumeran los trabajos programados previamente que proporciona la monetización y los horarios en los que se programaron para ejecutarse (todos los horarios que se indican están en UTC). También se indica el activador de cada trabajo.

Además de los trabajos mencionados anteriormente, hay otros que puedes habilitar a través de notificaciones de eventos, como se indica en la siguiente tabla. Para obtener más información, consulta Cómo configurar las notificaciones.

Administra la programación de trabajos de monetización con la API

En las siguientes secciones, se describe cómo administrar la programación de trabajos de monetización con la API:

• Configura activadores
• Cómo crear expresiones cron
• Visualiza trabajos programados con la API
• Cómo actualizar trabajos programados con la API
• Cómo inhabilitar y volver a habilitar un trabajo programado con la API

Para obtener más información sobre las APIs que se describen en esta sección, consulta Trabajos programados en la referencia de la API.

Configura activadores

El programador depende de los activadores para ejecutar trabajos. Un trabajo programado se ejecuta cuando se ejecuta su activador asociado. Las propiedades de un activador configuran la ejecución del trabajo y, al establecer el valor de estas propiedades, puedes controlar las características de la ejecución del trabajo, como cuándo se ejecuta un trabajo y con qué frecuencia.

Los dos tipos de activadores más comunes son los activadores cron y los activadores simples. Un activador cron tiene una propiedad cronExpression que especifica un programa de ejecución. Un activador simple no tiene una propiedad cronExpression; debes especificar la propiedad startTime para indicar cuándo entra en vigencia el activador y, de manera opcional, la propiedad endTime.

Las propiedades del activador son las siguientes (todas las horas que se indican están en UTC):

Cómo crear expresiones cron

Una expresión de cron es una cadena que consta de seis o siete campos separados por espacios en blanco. La expresión representa un conjunto de horas, normalmente como un programa para ejecutar una rutina. Las expresiones Cron que se especifican en la propiedad cronExpression de un activador se usan para programar la ejecución de ese activador.

Donde:

Los caracteres especiales se definen de la siguiente manera:

Estos son algunos ejemplos de expresiones cron (todos los horarios que se indican están en UTC):

Visualiza trabajos programados con la API

Puedes ver todos los trabajos programados actualmente si envías una solicitud GET a /triggers?orgid={org_name}.

Por ejemplo:

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

A continuación, se proporciona un ejemplo de la respuesta.

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

También puedes ver un trabajo programado específico si emites una solicitud GET a /triggers/{trig_id}, donde {trig_id} es la identificación del activador del trabajo, como se describe en Descripción general de los trabajos programados. Por ejemplo:

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

A continuación, se proporciona un ejemplo de la respuesta.

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

Actualiza trabajos programados con la API

Puedes actualizar un trabajo programado cambiando las propiedades de su activador. Por ejemplo, es posible que debas cambiar el programa de ejecución del activador.

En el caso de los trabajos activados por cron (es decir, los trabajos que incluyen un valor de expresión cron), solo puedes cambiar los valores de las propiedades cronExpression y habilitadas. Se ignoran otros cambios. Para los trabajos que no especifican un valor de expresión cron, puedes cambiar otras propiedades, como startTime o priority.

Para actualizar un trabajo programado, envía una solicitud PUT a /triggers/{trig_id}, donde {trig_id} es la identificación del activador de trabajo, como se describe en Descripción general de los trabajos programados. Cuando realices la actualización, deberás especificar en el cuerpo de la solicitud la configuración actualizada y el ID del activador.

Por ejemplo, la siguiente solicitud actualiza la expresión cron del trabajo de renovación del nuevo plan de tarifas para desarrolladores para que se ejecute todos los días a las 5 a.m. (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

Cómo inhabilitar y volver a habilitar un trabajo programado con la API

Para inhabilitar un trabajo programado, establece el valor de la propiedad enabled de su activador en false. Por ejemplo:

$ 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 volver a habilitar un trabajo inhabilitado, establece el valor de la propiedad enabled de su activador en verdadero.

Próximos pasos

Es recomendable que vuelvas a sincronizar periódicamente con la monetización tu organización y los desarrolladores, las aplicaciones y los productos que creaste con los servicios de la API de Edge. Obtén más información en Cómo sincronizar los datos de Apigee Edge con la monetización.