Расписание заданий по монетизации

Вы просматриваете документацию Apigee Edge .
Перейдите в документацию Apigee X.info

Обзор запланированных заданий

Монетизация предоставляет планировщик заданий и набор заданий, которые предварительно запланированы для выполнения в указанное время.

В таблице ниже перечислены запланированные задания, предоставляемые системой монетизации, и время их выполнения (все время указано в формате UTC). Также указан триггер для каждого задания.

Помимо перечисленных выше задач, существуют задачи, которые можно активировать с помощью уведомлений о событиях, как показано в следующей таблице. Для получения дополнительной информации см. раздел «Настройка уведомлений» .

Управление расписанием заданий монетизации с помощью API.

В следующих разделах описано, как управлять расписанием заданий монетизации с помощью API:

• Настройка триггеров
• Создание выражений cron
• Просмотр запланированных заданий с помощью API
• Обновление запланированных заданий с помощью API
• Отключение и повторное включение запланированного задания с помощью API

Для получения дополнительной информации об API, описанных в этом разделе, см. раздел «Запланированные задания» в справочнике API.

Настройка триггеров

Планировщик использует триггеры для выполнения заданий. Запланированное задание выполняется, когда срабатывает связанный с ним триггер. Свойства триггера настраивают выполнение задания, и, задавая значения этих свойств, вы можете управлять характеристиками выполнения задания, такими как время и частота его выполнения.

Наиболее распространенные типы триггеров — это cron-триггеры и простые триггеры . У cron-триггера есть свойство cronExpression , которое задает расписание выполнения. У простого триггера свойства cronExpression нет; вы указываете startTime , чтобы определить, когда триггер вступит в силу, и, при необходимости, endTime .

Свойства триггера следующие (все указанные времена приведены в формате UTC):

Создание выражений cron

Выражение cron представляет собой строку, состоящую из шести или семи полей, разделенных пробелами. Выражение обозначает набор временных интервалов, обычно в виде расписания выполнения процедуры. Выражения cron, указанные в свойстве cronExpression триггера, используются для планирования выполнения этого триггера.

Где:

Специальные символы определены следующим образом:

Вот несколько примеров выражений cron (все указанные времена приведены в формате UTC):

Просмотр запланированных заданий с помощью API

Вы можете просмотреть все запланированные на данный момент задания, отправив GET-запрос по адресу /triggers?orgid={org_name} .

Например:

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

Ниже приведён пример ответа:

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

Вы также можете просмотреть конкретное запланированное задание, отправив GET-запрос по адресу /triggers/{trig_id} , где {trig_id} — это идентификатор триггера задания, как описано в разделе «Обзор запланированных заданий» . Например:

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

Ниже приведён пример ответа:

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

Обновление запланированных заданий с помощью API

Вы можете обновить запланированное задание, изменив свойства его триггера. Например, вам может потребоваться изменить расписание выполнения триггера.

Для заданий, запускаемых по расписанию (то есть заданий, содержащих значение выражения cron), можно изменять только значения свойств cronExpression и enabled. Другие изменения игнорируются. Для заданий, не указывающих значение выражения cron, можно изменять другие свойства, такие как startTime или priority .

Для обновления запланированного задания отправьте PUT-запрос по адресу /triggers/{trig_id} , где {trig_id} — это идентификатор триггера задания, как описано в разделе «Обзор запланированных заданий» . При внесении изменений необходимо указать в теле запроса обновленные настройки и идентификатор триггера.

Например, следующий запрос обновляет выражение cron для задания «Продление тарифного плана для новых разработчиков», чтобы оно запускалось ежедневно в 5: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

Отключение и повторное включение запланированного задания с помощью API

Чтобы отключить запланированное задание, установите значение свойства enabled его триггера в значение false. Например:

$ 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

Чтобы повторно включить отключенное задание, установите значение свойства enabled его триггера в значение true.

Следующие шаги

Рекомендуется периодически синхронизировать вашу организацию, а также разработчиков, приложения и продукты, созданные с использованием Edge API Services, с системой монетизации. Подробнее об этом см. в разделе «Синхронизация данных Apigee Edge с системой монетизации» .