Активация и деактивация задачи

Содержание раздела
  1. URL
  2. Заголовки запроса
    1. [ x-request-id ]
  3. Тело запроса
    1. active
  4. Ограничения
  5. Примеры cURL-запросов
    1. Активация задачи
    2. Деактивация задачи

POST-метод активирует или деактивирует задачу планировщика.

Деактивация задачи не прерывает ее текущее выполнение.

URL

{baseUrl}/api/v1/scheduler/jobs/{job}

Параметры:

  • baseUrl — адрес ноды Prostore, состоящий из IP-адреса или доменного имени и номера порта;
  • job — имя активируемой или деактивируемой задачи.

Заголовки запроса

[ x-request-id ]

Задает уникальный идентификатор HTTP-запроса. Если не указан, система генерирует UUID-значение и возвращает его в качестве идентификатора в ответе.

Тело запроса

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

active

Признак активности задачи:

  • true — активировать задачу. Время очередного запуска задачи по ее расписанию вычисляется относительно текущего времени;
  • false — деактивировать задачу. Время очередного запуска устанавливается равным null, и задача не выполняется.

Ограничения

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

Примеры cURL-запросов

Активация задачи 

curl -X 'POST' \
  'http://localhost:9090/api/v1/scheduler/jobs/sales_upload_every_15_min' \
  -H 'x-request-id: 9c3f5b71-4e28-4a06-8d3b-6f21c47ea095' \
  -H 'Content-Type: application/json' \
  -d '{
    "active": true
  }'

Деактивация задачи 

curl -X 'POST' \
  'http://localhost:9090/api/v1/scheduler/jobs/sales_upload_every_15_min' \
  -H 'x-request-id: 51a8d0e6-7b34-4c9f-a25e-83d16b0f4c72' \
  -H 'Content-Type: application/json' \
  -d '{
    "active": false
  }'