vm.php¶

Модуль управления виртуальными машинами (VM), предоставляющий API для создания, получения, удаления и восстановления снапшотов, а также загрузки статистики.

Методы API¶

Метод	Действие	Описание
`create_snapshot`	создание снапшота	Инициирует создание снапшота для указанной виртуальной машины. Возвращает ключ задачи для отслеживания статуса.
`get_snapshot`	получение списка снапшотов	Возвращает список снапшотов и настройки для указанной виртуальной машины.
`load_stats`	загрузка статистики	Инициирует загрузку статистики использования ресурсов для виртуальной машины.
`remove_snapshot`	удаление снапшота	Инициирует удаление снапшота с указанным именем.
`restore_snapshot`	восстановление снапшота	Инициирует восстановление состояния виртуальной машины из снапшота.
`update_restore_settings`	обновление настроек восстановления	Обновляет настройки автоматического восстановления и ротации снапшотов для указанной виртуальной машины.

vm/create_snapshot¶

Инициирует создание снапшота для указанной виртуальной машины. Возвращает ключ задачи для отслеживания статуса.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `create_snapshot`
token	✅	string	Токен авторизации пользователя
id	✅	int	Уникальный идентификатор виртуальной машины
name	✅	string	Имя снапшота (разрешены символы a-zA-Z0-9_-.)
type	❌	string	Тип снапшота (по умолчанию 'snapshot')
num_rotation	❌	int	Количество вращений снапшотов (опционально, значение игнорируется в текущей реализации)

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

curl -s "https://invapi.hostkey.ru/vm.php" -X POST \
--data "action=create_snapshot" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE" \
--data "name=VALUE"

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

{
"result": "OK",
"module": "vm",
"action": "create_snapshot",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

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

{
"code": -1,
"message": "failed to request snapshot creation for $id"
}

vm/get_snapshot¶

Возвращает список снапшотов и настройки для указанной виртуальной машины.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_snapshot`
token	✅	string	Токен авторизации
id	✅	int	Идентификатор виртуальной машины
type	❌	string	Тип снапшота (по умолчанию 'snapshot')

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

curl -s "https://invapi.hostkey.ru/vm.php" -X POST \
--data "action=get_snapshot" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"

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

{
"result": "OK",
"module": "vm",
"action": "get_snapshot",
"callback": "7bc29eb23fb1b879b21fce509597f07c",
"settings": {
"num_rotation": 5,
"type": "snapshot"
}
}

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

{
"code": -1,
"message": "failed to request snapshots list for $id"
}

vm/load_stats¶

Инициирует загрузку статистики использования ресурсов для виртуальной машины.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/vm.php" -X POST \
--data "action=load_stats" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"

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

{
"result": "OK",
"module": "vm",
"action": "load_stats",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

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

{
"code": -1,
"message": "failed to request stats for $id"
}

vm/remove_snapshot¶

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

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `remove_snapshot`
token	✅	string	Токен авторизации
id	✅	int	Идентификатор виртуальной машины
name	✅	string	Имя снапшота для удаления
type	❌	string	Тип снапшота (по умолчанию 'snapshot')
openstack_id	❌	string	Идентификатор снапшота в OpenStack

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

curl -s "https://invapi.hostkey.ru/vm.php" -X POST \
--data "action=remove_snapshot" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE" \
--data "name=VALUE"

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

{
"result": "OK",
"module": "vm",
"action": "remove_snapshot",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

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

{
"code": -1,
"message": "failed to request snapshot removal for $id"
}

vm/restore_snapshot¶

Инициирует восстановление состояния виртуальной машины из снапшота.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `restore_snapshot`
token	✅	string	Токен авторизации
id	✅	int	Идентификатор виртуальной машины
name	✅	string	Имя снапшота для восстановления
type	❌	string	Тип снапшота (по умолчанию 'snapshot')
openstack_id	❌	string	Идентификатор снапшота в OpenStack

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

curl -s "https://invapi.hostkey.ru/vm.php" -X POST \
--data "action=restore_snapshot" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE" \
--data "name=VALUE"

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

{
"result": "OK",
"module": "vm",
"action": "restore_snapshot",
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

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

{
"code": -1,
"message": "failed to request restore from snapshot for $id"
}

vm/update_restore_settings¶

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

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `update_restore_settings`
token	✅	string	Токен авторизации пользователя
id	✅	int	Уникальный идентификатор виртуальной машины
type	❌	string	Тип снапшота (по умолчанию: snapshot)
enable_rotation	❌	int	Включить ротацию снапшотов (1 - да, 0 - нет)
exclude_rotation[]	❌	`array<string>`	Массив имен снапшотов, которые нужно исключить из ротации

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

curl -s "https://invapi.hostkey.ru/vm.php" -X POST \
--data "action=update_restore_settings" \
--data "token=HOSTKEY_TOKEN" \
--data "id=12345" \
--data "type=snapshot" \
--data "enable_rotation=1" \
--data "exclude_rotation[]=backup_1" \
--data "exclude_rotation[]=backup_2"

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

{
"result": "OK",
"module": "vm",
"action": "update_restore_settings"
}

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

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