vm.php¶

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

Методы API¶

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

vm/create_snapshot¶

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

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/vm" -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 - {$skey['error']}"
}

vm/get_snapshot¶

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

HTTP-метод: GET

Параметры:

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

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

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

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

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

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

{
"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" -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')

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

curl -s "https://invapi.hostkey.ru/vm" -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 - {$skey['error']}"
}

vm/restore_snapshot¶

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

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/vm" -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 - {$skey[\"error\"]}"
}