cleanup.php¶

В этой статье

• Методы API
• cleanup/autodeploy_timeout
• cleanup/check_email
• cleanup/check_vm
• cleanup/cleanup_auth_attempts
• cleanup/cleanup_ipmi
• cleanup/cleanup_iso
• cleanup/cleanup_old_ip_ranges
• cleanup/cleanup_s3_journal
• cleanup/cleanup_servers
• cleanup/cleanup_traffic
• cleanup/cleanup_upgrade_invoices
• cleanup/get_currency_rates
• cleanup/paygine_check_pending_refunds
• cleanup/preview_rates
• cleanup/reload_traffic_data
• cleanup/s3_calculate_overage
• cleanup/sync_billing_status
• cleanup/update_components
• cleanup/update_hw_config
• cleanup/update_currency_rates
• cleanup/update_billing_currency_rates
• cleanup/update_jira_organizations
• cleanup/update_rates
• cleanup/update_traffic_rates
• cleanup/yookassa_check_pending_refunds

API для выполнения периодических задач по очистке данных (cleanup), включая управление IP-адресами, ISO-образами, попытками авторизации и другими системными процессами.

Методы API¶

cleanup/autodeploy_timeout¶

Запускает процесс очистки (отмены) просроченных деплоев prebill-VPS. Метод является устаревшим и переведен на выполнение через Jenkins.

HTTP-метод: POST

Параметры:

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

{
"result": "OK",
"data": [
{
"server": 123,
"ticket": "456",
"status": "cancelled"
}
]
}

{
"code": -1,
"message": "action required"
}

cleanup/check_email¶

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

HTTP-метод: GET

Параметры:

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

{
"result": "ok",
"data": true
}

{
"code": -1,
"message": "action required"
}

cleanup/check_vm¶

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

HTTP-метод: POST|GET

Параметры:

curl -s "https://invapi.hostkey.ru/cleanup.php" -X POST \
--data "action=check_vm" \
--data "count=10" \
--data "skip=0" \
--data "status=running"

{
"result": "OK",
"message": "check_vm: done for [count] servers"
}

{
"code": -1,
"message": "cleanup/check_vm: action required"
}

cleanup/cleanup_auth_attempts¶

Запускает процесс очистки записей о неудачных попытке входа (brute-force protection).

HTTP-метод: POST

Параметры:

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

{
"result": "OK"
}

{
"code": -1,
"message": "cleanup/cleanup_auth_attempts: action required"
}

cleanup/cleanup_ipmi¶

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

HTTP-метод: POST

Параметры:

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

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

{
"code": -1,
"message": "$module/$action: action required"
}

cleanup/cleanup_iso¶

Удаляет устаревшие ISO-монтирования.

HTTP-метод: POST

Параметры:

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

{
"result": "OK",
"statistic": {
"mounted": [],
"deleted": [],
"failure": [],
"skipped": []
}
}

{
"-1": "cleanup/cleanup_iso: days must be a positive integer"
}

cleanup/cleanup_old_ip_ranges¶

Удаляет подсети и IPv4 диапазоны, помеченные как 'Old', если срок их действия (tag value) превышает 30 дней.

HTTP-метод: POST

Параметры:

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

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

{
"code": -1,
"message": "$module/$action: $err"
}

cleanup/cleanup_s3_journal¶

Очищает историю журналов в хранилище S3. Метод запускается через Jenkins.

HTTP-метод: POST

Параметры:

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

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

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

cleanup/cleanup_servers¶

Запускает процесс очистки данных серверов, включая теги (deploy_date, autodeploy_timeout, fixed_price), обновление размера eq, очистку данных Component1, очистку RR-записей через PDNS и очистку stalled TT серверов.

HTTP-метод: POST

Параметры:

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

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

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

cleanup/cleanup_traffic¶

Выполняет очистку периодов трафика и профилей шейпинга.

HTTP-метод: POST

Параметры:

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

{
"result": "OK",
"summary": {
"update_traffic_periods": "mixed",
"cleanup_shape_traffic": "array"
}
}

{
"code": -1,
"message": "$module/cleanup_traffic: $err"
}

cleanup/cleanup_upgrade_invoices¶

Запускает процесс очистки инвойсов на повышение (выполняется через Jenkins). Метод является устаревшим (retired) и перенаправляет запрос в legacy-обработчик.

HTTP-метод: POST

Параметры:

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

{
"result": "OK",
"summary": [
{
"invoice_id": "integer|string",
"result": "string"
}
]
}

{
"-1": {
"code": -1,
"message": "action required"
},
"-2": {
"code": -2,
"message": "logout error"
}
}

cleanup/get_currency_rates¶

Возвращает текущий курс обмена (RUB/EUR).

HTTP-метод: GET

Параметры:

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

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

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

cleanup/paygine_check_pending_refunds¶

Запускает процесс проверки ожидающих возвратов через Jenkins.

HTTP-метод: POST

Параметры:

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

{
"result": "unknown",
"module": "cleanup",
"action": "paygine_check_pending_refunds",
"data": "unknown"
}

{
"code": -1,
"message": "cleanup/paygine_check_pending_refunds: [error message]"
}

cleanup/preview_rates¶

Выполняет предварительную проверку изменения цен для конкретного сервера в режиме dry-run.

HTTP-метод: GET

Параметры:

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

{
"result": "OK",
"summary": {
"roi_price": 0.0,
"elec_eur_price": 0.0,
"elec_rur_price": 0.0,
"full_eur_price": 0.0,
"full_rur_price": 0.0,
"colo_eur_price": 0.0,
"colo_rur_price": 0.0,
"deprecated": 0,
"tdp": 0.0,
"cpu_power_price_diff": 0.0
}
}

{
"code": -1,
"message": "server_id is required"
}

cleanup/reload_traffic_data¶

Запускает процесс обновления периодов и счетчиков трафика для конкретного ID.

HTTP-метод: POST

Параметры:

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

{
"result": "OK"
}

{
"-1": "No id provided"
}

cleanup/s3_calculate_overage¶

Запускает процесс расчета превышений использования S3 через Jenkins.

HTTP-метод: POST

Параметры:

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

{
"result": "Любой тип данных (результат выполнения run_with_jenkins)"
}

{
"code": -1,
"message": "action required"
}

cleanup/sync_billing_status¶

Синхронизирует данные о компонентах с внешним биллингом (WHMCS).

HTTP-метод: POST

Параметры:

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

{
"result": "OK",
"data": [
"string (сообщение о статусе компонента и ответе WHMCS)"
]
}

{
"code": -1,
"message": "Error during sync"
}

cleanup/update_components¶

Запускает процесс обновления расположения (locations) всех компонентов.

HTTP-метод: POST

Параметры:

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

{
"result": "OK",
"message": "update_components: done {count} components in {seconds} sec"
}

{
"code": -1,
"message": "{module}/update_components: {exception_message}"
}

cleanup/update_hw_config¶

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

HTTP-метод: POST

Параметры:

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

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

{
"code": -1,
"message": "action required"
}

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 [rate]",
"tags_cleared": []
}

{
"result": "Error",
"message": "Failed to update EUR costs"
}

cleanup/update_billing_currency_rates¶

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

HTTP-метод: POST

Параметры:

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

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

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

cleanup/update_jira_organizations¶

Запускает процесс синхронизации организаций с Jira через Jenkins. Метод является устаревшим и переведен на выполнение через расписание (IAINT-2562).

HTTP-метод: POST

Параметры:

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

{
"result": "OK",
"organizations": [
{
"id": 123,
"name": "Example Org",
"user_key": "jdoe",
"user_name": "John Doe",
"emailAddress": "jdoe@example.com",
"displayName": "John Doe",
"active": true
}
]
}

{
"result": "error",
"message": "Failed to update organizations: error message"
}

cleanup/update_rates¶

Обновляет цены (sale/rent) для серверов в зависимости от выбранного этапа и локации. Поддерживает обновление конкретного сервера.

HTTP-метод: GET

Параметры:

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

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

{
"code": -1,
"message": "Error during price update"
}

cleanup/update_traffic_rates¶

Актуализирует стоимость входящего и исходящего трафика для активных серверов клиентов.

HTTP-метод: GET

Параметры:

curl -s "https://invapi.hostkey.ru/cleanup.php" -X GET \
--data "action=update_traffic_rates" \
--data "dry_run=1" \
--data "location=AMS-01"

{
"result": "OK",
"summary": {
"mode": "live|dry_run",
"description": "string",
"stats": {
"scanned": 0,
"tagged": 0,
"untagged": 0,
"tag_plan_missing": 0,
"matched_by_inference": 0,
"no_match": 0,
"ambiguous": 0,
"needs_update": 0,
"already_correct": 0
},
"updated": 0,
"server_ids": []
}
}

{
"code": -1,
"message": "Error updating traffic rates"
}

cleanup/yookassa_check_pending_refunds¶

Запускает процесс проверки незавершенных возвратов через платежный шлюз Yookassa. Выполняется как Jenkins job.

HTTP-метод: POST

Параметры:

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

{
"result": "unknown",
"data": null
}

{
"code": -1,
"message": "action required",
"custom_error": {
"result": "string (status code)",
"error": "$module/$action: $err"
}
}