Полный перечень всех команд «Апдейтера» есть в SWAGGER-документации, которая доступна по адресу http://updaterHost:port/swagger/index.html
Текущая спецификация в JSON — swagger.json

Для взаимодействия с «Апдейтером» рекомендуем использовать SWAGGER или приложения для работы с API (например Postman, SoapUI). 
Ниже команды для консоли указаны лишь в качестве универсального примера.

Основные команды

Описание

Команда для консоли

(в примерах умолчательный порт 3000, и запросы выполняются с сервера Апдейтера)

Авторизация

(включена если в updater.yaml задан http_auth, 

тогда к запросам добавляется -u username:password )

Получить версию «Апдейтера» и приложенийcurl -X GET http://localhost:3000/info/versionвсегда доступен
Перечитать и обновить текущие файлы конфигурации приложенияcurl -X PATCH http://localhost:3000/info/config

Получить историю вызовов Апдейтера за весь период

(или N последних дней)

curl -X GET http://localhost:3000/info/history

Получить логи «Апдейтера»

Получить журналы приложения за период (по умолчанию 3 дня)

curl -X GET http://localhost:3000/info/log > logs.zip

или

curl -X GET http://localhost:3000/info/log?from=20241110&to=20241202 > logs_from_to.zip

Скачать и обновить справочник

В примере справочника адресов factor_fias в «Факторе»

curl -X POST -d '{"dictionary":"factor_fias", "node":"factor"}' http://localhost:3000/updater/upload

-u hflabs:hflabs_key

Скачать справочник

В примере справочника адресов factor_fias в «Факторе»

curl -X POST -d '{"dictionary":"factor_fias", "node":"factor"}' http://localhost:3000/updater/download


Добавить задачу в расписание

В примере настройка расписания для скачивания и обновления справочника банков в «Подсказках»

curl -X POST -d '[{"task":"upload","node":"suggestions","schedule":"00 20 * * 4","dictionaries":["suggestions_bank"]}]' http://localhost:3000/schedule

Получить список задачcurl -X GET http://localhost:3000/schedule
Удалить задачу из расписанияcurl -X 'DELETE' http://localhost:3000/schedule/{scheduleId}

  • Нет меток