backup_journal.php¶

В этой статье

Методы API

backup_journal/list

backup_journal/stats

Модуль журнала резервного копирования: получение статистики и списков выполненных операций

Методы API¶

Метод	Действие	Описание
`list`	получение списка записей журнала	Возвращает список задач резервного копирования, отфильтрованных по заданным критериям.
`stats`	получение статистики	Возвращает агрегированную статистику по журналам резервного копирования.

backup_journal/list¶

Возвращает список задач резервного копирования, отфильтрованных по заданным критериям.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `list`
token	✅	string	Токен авторизации
id	❌	integer	Идентификатор задачи резервного копирования
eq_id	❌	integer	Идентификатор сервера
billing	❌	string	Биллинг клиента
email	❌	string	Email клиента
location	❌	string	Местоположение сервера
date_from	❌	string	Дата начала периода (в формате YYYY-MM-DD)
date_to	❌	string	Дата окончания периода (в формате YYYY-MM-DD)
type	❌	string	Тип записи журнала: backup_success,backup_failure,backup_running

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

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

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

{
"result": "OK",
"module": "backup_journal",
"action": "list",
"data": [
{
"id": 12345,
"eq_id": 678,
"billing": "client_account_01",
"email": "user@example.com",
"location": "US",
"start": "2024-01-01T00:00:00Z",
"type": "backup_success"
}
]
}

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

{
"400": {
"message": "No action specified"
},
"403": {
"message": "Authorization required"
},
"404": {
"message": "Action is not recognized"
}
}

backup_journal/stats¶

Возвращает агрегированную статистику по журналам резервного копирования.

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": -2,
"error": "Invalid hash",
"code": "INVALID_HASH"
}

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

{
"code": -1,
"message": "Permission denied"
}