reports.php¶

Модуль отчетов и аналитики: управление пресетами, мониторинг трафика, отчеты по биллингу, инвойсам и системным логам.

Методы API¶

Метод	Действие	Описание
`asa_log`	логирование ASA	Сохраняет запись в журнал аудита (ASA log) с информацией о действиях пользователя и IP-адресах.
`count_software_installs`	обновление статистики ПО	Запускает процесс пересчета и обновления тегов количества установленного программного обеспечения.
`create_preset_reports`	инициализация пресетов	Инициализирует системные отчеты по пресетам.
`execute`	выполнение отчета	Выполняет выполнение конкретного отчета по ID.
`generate_daily`	генерация ежедневных отчетов	Запускает процесс генерации ежедневных отчетов.
`ovirt_ip`	получение IP Ovirt	Возвращает список IP-адресов, связанных с инфраструктурой Ovirt.
`port_of_virt_node`	порты узлов виртуализации	Возвращает данные о портах узлов виртуализации в указанной локации.
`tplatforms`	получение отчета по использованию платформ	Генерирует отчет об использовании t-платформ за указанный период.
`windows_ip`	получение списка IP-адресов Windows-серверов	Возвращает список IP-адресов серверов с лицензированной ОС Windows для доступа к серверу активации.

reports/asa_log¶

Сохраняет запись в журнал аудита (ASA log) с информацией о действиях пользователя и IP-адресах.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `asa_log`
token	✅	string	Токен авторизации
message	❌	string	JSON-строка с данными лога (action, username, ipinfo, ipexternal, message, ipinternal)
ipinternal	✅	string	Параметр `ipinternal`
username	✅	string	Параметр `username`
ipinfo	✅	string	Параметр `ipinfo`
ipexternal	✅	string	Параметр `ipexternal`

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=asa_log" \
--data "token=VALUE" \
--data "ipinternal=VALUE" \
--data "username=VALUE" \
--data "ipinfo=VALUE" \
--data "ipexternal=VALUE"

Пример успешного ответа

{
"result": "OK",
"message": "{\"ipinternal\": \"127.0.0.1\", \"message\": \"test log\"}"
}

Примеры ошибок

{
"code": -1,
"message": "Authentication required or invalid token"
}

reports/count_software_installs¶

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

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `count_software_installs`
token	✅	string	Токен авторизации

Пример запроса

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

Пример успешного ответа

{
"result": "OK",
"module": "reports",
"action": "count_software_installs",
"message": "Software installs updated"
}

Примеры ошибок

{
"code": -1,
"message": "Error during software install count update"
}

reports/create_preset_reports¶

Инициализирует системные отчеты по пресетам.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `create_preset_reports`
token	✅	string	Токен авторизации

Пример запроса

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

Пример успешного ответа

{
"result": "OK",
"module": "module_name",
"action": "create_preset_reports"
}

Примеры ошибок

{
"code": -1,
"message": "Failed to initialize preset reports"
}

reports/execute¶

Выполняет выполнение конкретного отчета по ID.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `execute`
token	✅	string	Токен авторизации
id	❌	integer	ID отчета для выполнения. Может быть получен из POST или GET запроса.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=execute" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"

Пример успешного ответа

{
"result": "OK",
"module": "string",
"action": "execute",
"report": {}
}

Примеры ошибок

{
"code": -1,
"message": "Report execution failed"
}

reports/generate_daily¶

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

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `generate_daily`
token	✅	string	Токен авторизации
id	✅	integer	ID для генерации отчета

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=generate_daily" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"

Пример успешного ответа

{
"result": "OK"
}

Примеры ошибок

{
"code": -1,
"message": "Error during daily report generation"
}

reports/ovirt_ip¶

Возвращает список IP-адресов, связанных с инфраструктурой Ovirt.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `ovirt_ip`
token	✅	string	Токен авторизации
location	❌	string	Местоположение или идентификатор локации для формирования отчета.

Пример запроса

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

Пример успешного ответа

{
"result": "OK",
"action": "ovirt_ip",
"data": [
{
"id": 1,
"ip": "192.168.1.10",
"status": "active"
}
]
}

Примеры ошибок

{
"code": -1,
"message": "Failed to fetch Ovirt IPs"
}

reports/port_of_virt_node¶

Возвращает данные о портах узлов виртуализации в указанной локации.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `port_of_virt_node`
token	✅	string	Токен авторизации
location	✅	integer	Идентификатор локации для получения данных о портах узлов виртуализации

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=port_of_virt_node" \
--data "token=HOSTKEY_TOKEN" \
--data "location=VALUE"

Пример успешного ответа

{
"result": "OK",
"module": null,
"action": "port_of_virt_node",
"data": [
{
"id": 10,
"port": 80,
"status": "open"
}
]
}

Примеры ошибок

{
"code": -1,
"message": "Failed to fetch port data"
}

reports/tplatforms¶

Генерирует отчет об использовании t-платформ за указанный период.

HTTP-метод: POST|GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `tplatforms`
period_from	❌	string	Дата начала периода (формат Y-m-d H:i:s). По умолчанию -1.
period_to	❌	string	Дата окончания периода (формат Y-m-d H:i:s). По умолчанию -1.

Пример запроса

curl -s "https://invapi.hostkey.ru/reports.php" -X POST \
--data "action=tplatforms" \
--data "period_from=2023-01-01 00:00:00" \
--data "period_to=2023-12-31 23:59:59"

Пример успешного ответа

{
"result": "OK",
"module": null,
"action": "tplatforms",
"data": [
{
"platform_name": "Example Platform",
"usage_count": 150,
"status": "active"
}
]
}

Примеры ошибок

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

reports/windows_ip¶

Возвращает список IP-адресов серверов с лицензированной ОС Windows для доступа к серверу активации.

HTTP-метод: POST|GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `windows_ip`
location	❌	string	Локация (фильтр). По умолчанию пустая строка.

Пример запроса

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

Пример успешного ответа

{
"result": "OK",
"module": null,
"action": "windows_ip",
"data": [
{
"ip": "192.168.1.1",
"server_id": 105,
"status": "active"
}
]
}

Примеры ошибок

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