cleanup.php¶

Модуль очистки системных данных: управление таймаутами развертывания, проверка SMTP, очистка IPMI/NAT, работа с базами данных и ISO-образами

Методы API¶

cleanup/autodeploy_timeout¶

Запуск процесса очистки серверов, у которых истек таймаут автоматического развертывания.

HTTP-метод: POST|GET

Параметры:

curl -s "https://invapi.hostkey.ru/cleanup.php" -X POST \
--data "action=autodeploy_timeout" \
--data "token=HOSTKEY_TOKEN"

{
"result": "OK",
"data": [
{
"id": 123,
"status": "cleaned"
}
]
}

{
"code": -1,
"message": "Ошибка при выполнении очистки таймаутов"
}

cleanup/check_email¶

Отправка тестового письма для проверки работоспособности SMTP-соединения.

HTTP-метод: POST|GET

Параметры:

curl -s "https://invapi.hostkey.ru/cleanup.php" -X POST \
--data "action=check_email"

{
"result": "OK",
"action": "check_email",
"data": {
"status": "sent",
"recipient": "debug@example.com"
}
}

{
"code": -1,
"message": "Ошибка отправки письма"
}

cleanup/check_vm¶

Получение списка виртуальных машин с фильтрацией по статусу и пагинацией.

HTTP-метод: POST|GET

Параметры:

curl -s "https://invapi.hostkey.ru/cleanup.php" -X POST \
--data "action=check_vm"

{
"result": "OK",
"message": "check_vm: done for 10 servers"
}

{
"code": -1,
"message": "Ошибка при получении списка VM"
}

cleanup/cleanup_db¶

Метод-заглушка. Очистка базы данных выполняется планировщиком (CleanupDbWorker) через Jenkins.

HTTP-метод: POST|GET

Параметры:

curl -s "https://invapi.hostkey.ru/cleanup.php" -X POST \
--data "action=cleanup_db"

{
"result": "OK",
"message": "cleanup_db is handled by scheduler, this endpoint is a no-op"
}

{
"code": -1,
"message": "Метод не активен"
}

cleanup/cleanup_ipmi¶

Комплексная очистка: удаление неактивных записей IPMI, разблокировка IP в BIRD (через теги block_expire) и очистка NoVNC/ISO монтирований.

HTTP-метод: POST|GET

Параметры:

curl -s "https://invapi.hostkey.ru/cleanup.php" -X POST \
--data "action=cleanup_ipmi"

{
"result": "OK",
"message": "cleanup_ipmi: cleared NAT for <IP_LIST>"
}

{
"code": -1,
"message": "Ошибка при выполнении очистки IPMI/NAT"
}

cleanup/cleanup_iso¶

Очистка устаревших монтирований ISO-образов.

HTTP-метод: POST|GET

Параметры:

curl -s "https://invapi.hostkey.ru/cleanup.php" -X POST \
--data "action=cleanup_iso" \
--data "days=15"

{
"result": "OK",
"statistic": 5
}

{
"code": -1,
"message": "$module/$action: days must be a positive integer"
}

cleanup/cleanup_auth_attempts¶

Очистка записей о неудачных попытках входа (защита от брутфорса).

HTTP-метод: POST|GET

Параметры:

curl -s "https://invapi.hostkey.ru/cleanup.php" -X POST \
--data "action=cleanup_auth_attempts"

{
"result": "OK"
}

{
"code": -1,
"message": "Ошибка очистки попыток авторизации"
}

cleanup/cleanup_old_ip_ranges¶

Удаляет устаревшие IPv4 диапазоны, которые были помечены тегом 'moved_to_old_ranges' более 30 дней назад.

HTTP-метод: GET

Параметры:

curl -s "https://invapi.hostkey.ru/cleanup.php" -X GET \
--data "action=cleanup_old_ip_ranges"

{
"result": "OK",
"summary": [
"12 unused tags cleared",
"eq height updated",
"servers data cleaned",
"unused RR cleaned",
"Old deploy tags cleared"
]
}

{
"code": -1,
"message": "cleanup/cleanup_old_ip_ranges: error message"
}

cleanup/cleanup_s3_journal¶

Очищает историю журналов в хранилище S3.

HTTP-метод: GET

Параметры:

curl -s "https://invapi.hostkey.ru/cleanup.php" -X GET \
--data "action=cleanup_s3_journal"

{
"result": "OK",
"msg": "Journal S3 history cleared"
}

{
"code": -1,
"message": "Cleanup error"
}

cleanup/cleanup_servers¶

Выполняет комплексную очистку данных серверов, включая теги, RR и застрявшие TT-серверы.

HTTP-метод: GET

Параметры:

curl -s "https://invapi.hostkey.ru/cleanup.php" -X GET \
--data "action=cleanup_servers"

{
"result": "OK",
"summary": [
"5 unused tags cleared",
"eq height updated",
"servers data cleaned",
"unused RR cleaned",
"stalled TT servers cleared: 0"
]
}

{
"code": -1,
"message": "Cleanup error"
}

cleanup/cleanup_traffic¶

Обновляет периоды трафика и выполняет очистку шейпинга (overdue invoices).

HTTP-метод: GET

Параметры:

curl -s "https://invapi.hostkey.ru/cleanup.php" -X GET \
--data "action=cleanup_traffic"

{
"result": "OK",
"summary": {
"update_traffic_periods": 0,
"cleanup_shape_traffic": 0
}
}

{
"code": -1,
"message": "Cleanup error"
}

cleanup/cleanup_upgrade_invoices¶

Ищет и отменяет старые инвойсы на апгрейд через WHMCS.

HTTP-метод: GET

Параметры:

curl -s "https://invapi.hostkey.ru/cleanup.php" -X GET \
--data "action=cleanup_upgrade_invoices"

{
"result": "OK",
"summary": [
{
"component_id": 123,
"result": "cancelled"
}
]
}

{
"code": -1,
"message": "Cleanup error"
}

cleanup/get_currency_rates¶

Возвращает текущие курсы валют для расчета стоимости.

HTTP-метод: GET

Параметры:

curl -s "https://invapi.hostkey.ru/cleanup.php" -X GET \
--data "action=get_currency_rates" \
--data "token=HOSTKEY_TOKEN"

{
"result": "OK",
"rate": 1.05
}

{
"code": -1,
"message": "Error getting rates"
}

cleanup/reload_traffic_data¶

Пересчитывает периоды и счетчики трафика для конкретного ID.

HTTP-метод: POST|GET

Параметры:

curl -s "https://invapi.hostkey.ru/cleanup.php" -X POST \
--data "action=reload_traffic_data" \
--data "id=VALUE"

{
"result": "OK"
}

{
"code": -1,
"message": "No id provided"
}

cleanup/sync_billing_status¶

Синхронизирует данные о статусах оплаты из WHMCS для компонентов, у которых истек срок действия условий.

HTTP-метод: POST|GET

Параметры:

curl -s "https://invapi.hostkey.ru/cleanup.php" -X POST \
--data "action=sync_billing_status"

{
"result": "OK",
"data": [
"Component1 123 Condition_Component in invapi, bill status is active",
"Component1 456 Condition_Component in invapi, error: connection failed"
]
}

{
"code": -1,
"message": "Ошибка выполнения запроса к БД или WHMCS"
}

cleanup/update_components¶

Запускает процесс обновления локаций для всех компонентов.

HTTP-метод: POST|GET

Параметры:

curl -s "https://invapi.hostkey.ru/cleanup.php" -X POST \
--data "action=update_components"

{
"result": "OK",
"message": "update_components: done 15 components in 2 sec"
}

{
"code": -1,
"message": "Ошибка при выполнении обновления компонентов"
}

cleanup/update_hw_config¶

Запускает ежечасное обновление аппаратных конфигураций серверов.

HTTP-метод: POST|GET

Параметры:

curl -s "https://invapi.hostkey.ru/cleanup.php" -X POST \
--data "action=update_hw_config"

{
"result": "OK",
"message": "update_hardware configs: done 120 servers"
}

{
"code": -1,
"message": "Ошибка при обновлении конфигураций оборудования"
}

cleanup/update_currency_rates¶

Обновляет стоимость услуг в EUR на основе актуальных курсов.

HTTP-метод: POST|GET

Параметры:

curl -s "https://invapi.hostkey.ru/cleanup.php" -X POST \
--data "action=update_currency_rates"

{
"result": "OK",
"message": "EUR costs update with a rate 1.08, tags_cleared: []",
"tags_cleared": []
}

{
"code": -1,
"message": "Failed to update EUR costs"
}

cleanup/update_billing_currency_rates¶

Обновляет курсы валют в системе WHMCS для указанной локации.

HTTP-метод: POST|GET

Параметры:

curl -s "https://invapi.hostkey.ru/cleanup.php" -X POST \
--data "action=update_billing_currency_rates" \
--data "location=US"

{
"result": "OK",
"message": "{\"active\":true,\"code\":\"EUR\",\"identifier\":\"US\",\"result\":1}"
}

{
"code": -1,
"message": "Failed to update currency rates. No active billings found or update failed due to error."
}

cleanup/update_rates¶

Запускает процесс пересчета цен для серверов в зависимости от выбранного этапа или конкретного сервера.

HTTP-метод: POST|GET

Параметры:

curl -s "https://invapi.hostkey.ru/cleanup.php" -X POST \
--data "action=update_rates"

{
"result": "OK",
"summary": {}
}

{
"code": -1,
"message": "Ошибка при расчете цен"
}

cleanup/update_traffic_rates¶

Запускает процесс актуализации стоимостей входящего и исходящего трафика (cost_trafficIN/cost_traffic) для активных серверов.

HTTP-метод: GET|POST

Параметры:

curl -s "https://invapi.hostkey.ru/cleanup.php" -X GET|POST \
--data "action=update_traffic_rates"

{
"result": "OK",
"summary": [
"Обновление периодов трафика: 123",
"Очистка шейпа трафика: 45"
]
}

{
"code": -1,
"message": "Ошибка выполнения операции очистки трафика"
}

cleanup/yookassa_check_pending_refunds¶

Запускает фоновую задачу через Jenkins для проверки и обработки ожидающих возвратов в платежной системе YooKassa.

HTTP-метод: GET|POST

Параметры:

curl -s "https://invapi.hostkey.ru/cleanup.php" -X GET|POST \
--data "action=yookassa_check_pending_refunds"

{
"result": "OK",
"action": "yookassa_check_pending_refunds",
"data": {
"status": "completed",
"processed_count": 5
}
}

{
"code": -1,
"message": "Ошибка при запуске задачи через Jenkins"
}

cleanup/update_jira_organizations¶

Запускает процесс синхронизации и обновления данных организаций в системе Jira.

HTTP-метод: POST

Параметры:

curl -s "https://invapi.hostkey.ru/cleanup.php" -X POST \
--data "action=update_jira_organizations"

{
"result": "OK",
"organizations": {
"result": 1,
"data": []
}
}

{
"code": -1,
"message": "Failed to update organizations: error_details"
}