API
API
Core
| Метод | Запрос | Ответ | Описание |
|---|---|---|---|
HealthStatus | Empty | HealthStatusResponse | Проверка состояния системы. |
GetTLSConfig | Empty | GetTLSConfigResponse | Получение конфигурации TLS. |
Task
| Метод | Запрос | Ответ | Описание |
|---|---|---|---|
Create | TaskCreateRequest | ActionResponse | Создание задачи. |
List | Empty | TaskList | Получение списка задач. |
Get | ActionRequest | TaskItem | Получение информации о задаче. |
Wait | ActionRequest | TaskItem (поток) | Ожидание выполнения задачи. |
Auth
| Метод | Запрос | Ответ | Описание |
|---|---|---|---|
Login | LoginRequest | AuthResponse | Аутентификация пользователя. |
Logout | Empty | Empty | Выход из системы. |
ChangePassword | ChangePasswordRequest | Empty | Смена пароля. |
CreateAppAccessToken | CreateAppAccessTokenRequest | AuthResponse | Создание токена для доступа приложения. |
RefreshAccessToken | RefreshAccessTokenRequest | AuthResponse | Обновление токена доступа. |
AuthenticateRequest | AuthenticateRequestRequest | Empty | Проверка аутентификации запроса. |
Host
| Метод | Запрос | Ответ | Описание |
|---|---|---|---|
Get | Empty | ProcuratorHost | Получение информации о хосте. |
Certificate | Empty | ProcuratorCertificate | Получение сертификата. |
RenewCertificate | Empty | ProcuratorCertificate | Обновление сертификата. |
License | Empty | ProcuratorLicense | Получение данных лицензии. |
Services | Empty | ProcuratorServices | Список сервисов на хосте. |
Packages | Empty | ProcuratorPackages | Список пакетов. |
PciDevices | Empty | ProcuratorPCIDevices | Список PCI-устройств. |
TogglePciPassthrough | ActionRequest | ActionResponse | Включение/отключение PCI Passthrough. |
Associate | AssociateRequest | Empty | Ассоциация хоста со сферой. |
Disassociate | Empty | Empty | Удаление ассоциации хоста со сферой. |
MonitoringStream | MonitoringStreamRequest | MonitoringStreamMessage | Поток мониторинга данных с хоста. |
Datastores
| Метод | Запрос | Ответ | Описание |
|---|---|---|---|
Create | DatastoreCreateRequest | ActionResponse | Создание хранилища. |
List | Empty | DatastoreList | Список хранилищ. |
Get | ActionRequest | Datastore | Получение информации о хранилище. |
Delete | ActionRequest | ActionResponse | Удаление хранилища. |
BrowseFolder | BNRDFolderRequest | SindItem | Просмотр содержимого папки. |
NewFolder | BNRDFolderRequest | ActionResponse | Создание новой папки. |
MakeEmptyFile | MakeEmptyFileRequest | ActionResponse | Создание пустого файла. |
UploadFile | UploadFileRequest (поток) | UploadFileResponse | Загрузка файла в хранилище. |
RenameItem | BNRDFolderRequest | ActionResponse | Переименование объекта. |
CopyItem | CMItemRequest | ActionResponse | Копирование объекта. |
MoveItem | CMItemRequest | ActionResponse | Перемещение объекта. |
DeleteItem | BNRDFolderRequest | ActionResponse | Удаление объекта. |
DownloadFile | DownloadFileRequest | DownloadFileResponse (поток) | Загрузка файла из хранилища. |
Vms
| Метод | Запрос | Ответ | Описание |
|---|---|---|---|
Validate | ProcuratorVirtualMachine | ValidateResponse | Валидация параметров ВМ. |
Create | VMCreateRequest | ActionResponse | Создание ВМ. |
List | Empty | VmsListResponse | Список ВМ. |
ListWithParams | VmParamsRequest | VmsListResponse | Список ВМ с параметрами статистики. |
Remove | ActionRequest | ActionResponse | Удаление ВМ. |
Delete | ActionRequest | ActionResponse | Удаление ВМ с диска. |
Get | ActionRequest | ProcuratorVirtualMachine | Получение информации о ВМ. |
GetWithParams | VmParamsRequest | ProcuratorVirtualMachine | Получение ВМ с параметрами статистики. |
Update | ProcuratorVirtualMachine | ActionResponse | Обновление ВМ. |
PowerOn | ActionRequest | ActionResponse | Включение ВМ. |
PowerOff | ActionRequest | ActionResponse | Выключение ВМ. |
HardStop | ActionRequest | ActionResponse | Жесткая остановка ВМ. |
Reset | ActionRequest | ActionResponse | Сброс ВМ. |
ShutdownGuest | ActionRequest | ActionResponse | Завершение работы гостевой ОС. |
RestartGuest | ActionRequest | ActionResponse | Перезапуск гостевой ОС. |
Suspend | ActionRequest | ActionResponse | Приостановка ВМ. |
Resume | ActionRequest | ActionResponse | Возобновление работы ВМ. |
MountGuestTools | ActionRequest | ActionResponse | Подключение инструментов гостевой ОС. |
UnmountGuestTools | ActionRequest | ActionResponse | Отключение инструментов гостевой ОС. |
Screenshot | ActionRequest | ScreenShotResponse | Создание скриншота ВМ. |
MigrateHost | ActionMigrateRequest | ActionResponse | Миграция ВМ на другой хост. |
MigrateHostPrepare | MigrateHostMessage | MigrateHostMessage | Подготовка целевого хоста к миграции ВМ. |
MigrateHostFinish | MigrateHostMessage | MigrateHostMessage | Завершение миграции на целевом хосте. |
SendSessionsMetric | Empty | SessionsStream (поток) | Поток сессий и метрик. |
| Название сообщения | Поле | Тип | Описание |
|---|---|---|---|
| Empty | - | - | Пустое сообщение. |
| ValidateResponse | error_messages | repeated ValidationError | Список ошибок валидации. |
| pvm | ProcuratorVirtualMachine | Информация о виртуальной машине. | |
| ValidationError | field | string | Название поля, в котором обнаружена ошибка. |
| error_message | string | Сообщение об ошибке. | |
| ActionRequest | target_id | string | Идентификатор цели для выполнения действия. |
| VmParamsRequest | target_id | string | Идентификатор виртуальной машины. |
| cpu_stats | bool | Запрос статистики по CPU. | |
| storage_stats | bool | Запрос статистики по устройствам хранения. | |
| network_stats | bool | Запрос статистики по сетевым адаптерам. | |
| uptime | bool | Запрос информации о времени работы. | |
| guest_tools | bool | Запрос информации о гостевых инструментах. | |
| snapshots_stats | bool | Запрос информации о снимках виртуальных машин. | |
| LoginRequest | username | string | Имя пользователя для входа. |
| password | string | Пароль для входа. | |
| AuthResponse | access_token | string | Токен доступа для аутентификации. |
| access_token_expires_at | int64 | Время окончания действия токена доступа. | |
| refresh_token | string | Токен обновления для аутентификации. | |
| refresh_token_expires_at | int64 | Время окончания действия токена обновления. | |
| DatastoreCreateRequest | name | string | Название хранилища данных. |
| type_code | int32 | Код типа хранилища данных. | |
| server | string | IP-адрес сервера (для NFS). | |
| folder | string | Путь к папке (для NFS). | |
| readonly | bool | Указывает, что хранилище данных доступно только для чтения. | |
| version | float | Версия NFS (например, 3.0 или 4.1). | |
| devices | repeated string | Устройства, связанные с хранилищем данных. | |
| reinit | optional bool | Опция реинициализации для NFS. | |
| nconnect | optional int32 | Количество подключений NFS. | |
| ProcuratorVirtualMachine | deployment_name | string | Название развёртывания виртуальной машины. |
| name | string | Название виртуальной машины. | |
| uuid | string | UUID виртуальной машины. | |
| compatibility | string | Уровень совместимости. | |
| guest_os_family | string | Семейство гостевой ОС. | |
| guest_os_version | string | Версия гостевой ОС. | |
| storage | ProcVMStorage | Конфигурация хранилища виртуальной машины. | |
| machine_type | string | Тип машины (например, q35). | |
| HealthStatusResponse | status | int32 | Код статуса состояния. |
| version | string | Версия API. | |
| message | string | Сообщение о состоянии системы. |
Полная таблица методов gRPC API
Core
| Метод | Запрос | Ответ | Описание |
|---|---|---|---|
HealthStatus | Empty | HealthStatusResponse | Проверка состояния системы. |
| Пустое сообщение. | Код статуса, версия API, сообщение о состоянии. | ||
GetTLSConfig | Empty | GetTLSConfigResponse | Получение конфигурации TLS. |
| Пустое сообщение. | Параметры TLS, такие как сертификаты и настройки. |
Task
| Метод | Запрос | Ответ | Описание |
|---|---|---|---|
Create | TaskCreateRequest | ActionResponse | Создание задачи. |
| Параметры задачи (например, название, тип). | Результат выполнения действия. | ||
List | Empty | TaskList | Получение списка задач. |
| Пустое сообщение. | Список задач с их параметрами. | ||
Get | ActionRequest | TaskItem | Получение информации о задаче. |
| Идентификатор задачи. | Подробная информация о задаче. | ||
Wait | ActionRequest | TaskItem (поток) | Ожидание выполнения задачи. |
| Идентификатор задачи. | Постоянный поток с обновлениями по задаче. |
Auth
| Метод | Запрос | Ответ | Описание |
|---|---|---|---|
Login | LoginRequest | AuthResponse | Аутентификация пользователя. |
| Имя пользователя и пароль. | Токен доступа и токен обновления. | ||
Logout | Empty | Empty | Выход из системы. |
| Пустое сообщение. | Пустое сообщение. | ||
ChangePassword | ChangePasswordRequest | Empty | Смена пароля. |
| Старый и новый пароль. | Пустое сообщение. | ||
CreateAppAccessToken | CreateAppAccessTokenRequest | AuthResponse | Создание токена для доступа приложения. |
| Информация о приложении. | Токен доступа для приложения. | ||
RefreshAccessToken | RefreshAccessTokenRequest | AuthResponse | Обновление токена доступа. |
| Истёкший токен доступа. | Новый токен доступа. | ||
AuthenticateRequest | AuthenticateRequestRequest | Empty | Проверка аутентификации запроса. |
| Токен доступа. | Пустое сообщение при успешной проверке. |
Host
| Метод | Запрос | Ответ | Описание |
|---|---|---|---|
Get | Empty | ProcuratorHost | Получение информации о хосте. |
| Пустое сообщение. | Информация о хосте, например, IP, имя. | ||
Certificate | Empty | ProcuratorCertificate | Получение сертификата. |
| Пустое сообщение. | Сертификат хоста. | ||
RenewCertificate | Empty | ProcuratorCertificate | Обновление сертификата. |
| Пустое сообщение. | Новый сертификат. | ||
License | Empty | ProcuratorLicense | Получение данных лицензии. |
| Пустое сообщение. | Информация о лицензии. | ||
Services | Empty | ProcuratorServices | Список сервисов на хосте. |
| Пустое сообщение. | Список сервисов с их статусами. |
Datastores
| Метод | Запрос | Ответ | Описание |
|---|---|---|---|
Create | DatastoreCreateRequest | ActionResponse | Создание хранилища. |
| Параметры хранилища: название, тип, сервер. | Результат создания. | ||
List | Empty | DatastoreList | Список хранилищ. |
| Пустое сообщение. | Полный список хранилищ. | ||
Get | ActionRequest | Datastore | Получение информации о хранилище. |
| Идентификатор хранилища. | Подробная информация о хранилище. | ||
Delete | ActionRequest | ActionResponse | Удаление хранилища. |
| Идентификатор хранилища. | Результат удаления. |
Replication
| Метод | Запрос | Ответ | Описание |
|---|---|---|---|
Create | ReplicationCreateRequest | ActionResponse | Создание задания репликации. |
| Параметры задачи: источник, цель. | Результат создания. | ||
List | Empty | ReplicationList | Список задач репликации. |
| Пустое сообщение. | Полный список задач репликации. | ||
Get | ActionRequest | ReplicationTask | Получение данных о задаче репликации. |
| Идентификатор задачи. | Подробная информация о задаче. | ||
Delete | ActionRequest | ActionResponse | Удаление задачи репликации. |
| Идентификатор задачи. | Результат удаления. |