Download PDF
Download page Методы XML-RPC для команды onevm.
Методы XML-RPC для команды onevm
Пожалуйста, разместите таблицу или макрос, генерирующий таблицы, в макросе "Фильтр таблиц".
Таблица загружается. Пожалуйста, подождите...
Команда onevm | Метод XML-RPC | Требуемые разрешения |
---|---|---|
deploy | VM:ADMIN HOST:MANAGE | |
terminate suspend hold stop resume release poweroff reboot | VM:MANAGE | |
resched unresched | VM:ADMIN | |
migrate | VM:ADMIN HOST:MANAGE | |
disk-saveas | VM:MANAGE IMAGE:CREATE | |
disk-snapshot-create | VM:MANAGE IMAGE:MANAGE | |
disk-snapshot-delete | VM:MANAGE IMAGE:MANAGE | |
disk-snapshot-revert | VM:MANAGE | |
disk-snapshot-rename | VM:MANAGE | |
disk-attach | VM:MANAGE IMAGE:USE | |
disk-detach | VM:MANAGE | |
disk-resize | VM:MANAGE | |
nic-attach | VM:MANAGE NET:USE | |
nic-detach | VM:MANAGE | |
create | VM:CREATE IMAGE:USE NET:USE | |
show | VM:USE | |
chown chgrp | VM:MANAGE [USER:MANAGE] [GROUP:USE] | |
chmod | VM:<MANAGE/ADMIN> | |
rename | VM:MANAGE | |
snapshot-create | VM:MANAGE | |
snapshot-delete | VM:MANAGE | |
snapshot-revert | VM:MANAGE | |
resize | VM:MANAGE | |
update | VM:MANAGE | |
recover | VM:ADMIN | |
save | – (ruby method) | VM:MANAGE IMAGE:CREATE TEMPLATE:CREATE |
updateconf | VM:MANAGE | |
list top | VM:USE | |
list | VM:USE | |
– | VM:USE | |
lock | VM:MANAGE | |
unlock | VM:MANAGE |
Для развертывания пользователю требуются права VM:ADMIN. Этот пользователь обычно использует для планировщика реквизиты для входа oneadmin
.
Планировщик развертывает ВМ на серверах виртуализации с правами пользователя MANAGE и выше.
one.vm.allocate
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | String | Содержание нового шаблона ВМ. Синтаксис может быть стандартным |
IN | Boolean | Флаг создания ВМ:
|
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор выделяемого ресурса / Строка с ошибкой |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор кластера, вызвавшего ошибку |
one.vm.deploy
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
IN | Int | Идентификатор сервера виртуализации на котором будет запущена ВМ |
IN | Boolean | Значение |
IN | Int | Необязательный идентификатор целевого системного хранилища, в котором будет запущена ВМ. Может быть установлено значение |
IN | String | Шаблон с сетью, планирующей результат для сетевого интерфейса в режиме AUTO |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор ресурса / Строка с ошибкой |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор хранилища данных, вызвавшего ошибку |
one.vm.action
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | String | Имя действия, которое должно быть выполнено |
IN | Int | Идентификатор объекта |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор ресурса / Строка с ошибкой |
OUT | Int | Код ошибки |
Действие должно быть одним из:
terminate-hard — принудительная остановка ВМ;
terminate — остановка ВМ;
undeploy-hard — принудительное завершение работы ВМ;
undeploy — завершение работы ВМ;
poweroff-hard — принудительное отключение ВМ;
poweroff — отключение ВМ;
reboot-hard — принудительная перезагрузка ВМ;
reboot — перезагрузка ВМ;
hold — перевод ВМ в статус HOLD;
release — освобождение ВМ из статуса
HOLD;
stop — остановка ВМ;
suspend — остановка ВМ, при которой состояние ВМ (файл checkpoint) и образы дисков остаются на сервере, чтобы позже возобновить на нем ВМ;
resume — Возобновление сохраненной ВМ;
resched — установка флага для планировщика;
unresched — снятие флага для планировщика.
one.vm.migrate
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
IN | Int | Идентификатор сервера виртуализации на который планируется миграция ВМ |
IN | Boolean | Индикатор типа миграции:
|
IN | Boolean | Значение |
IN | Int | Идентификатор системного хранилища в которое планируется миграция ВМ |
IN | Int | Тип миграции:
|
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор ресурса / Строка с ошибкой |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор хранилища данных, вызвавшего ошибку |
one.vm.disksaveas
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
IN | Int | Идентификатор диска, выбранного для сохранения |
IN | String | Имя хранилища образов в котором будет сохранен диск |
IN | String | Тип нового образа (OS, CDROM, DATABLOCK). Если строка пустая, будет использован тип по умолчанию |
IN | Int | Идентификатор экспортируемого снимка, если идентификатор -1, будет использовано текущее состояние образа |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор вновь созданного образа / Строка с шибкой. Если шаблон был скопирован, новый идентификатор шаблона не будет выведен. Найти шаблон можно по имени: |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор образа/ хранилища данных, вызвавшего ошибку |
one.vm.disksnapshotcreate
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
IN | Int | Идентификатор диска, выбранного для сохранения |
IN | String | Описание снимка |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор нового снимка/ Строка с ошибкой |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор образа, вызвавшего ошибку |
one.vm.disksnapshotdelete
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
IN | Int | Идентификатор диска, выбранного для удаления |
IN | Int | Идентификатор снимка, выбранного для удаления |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор удаляемого снимка / Строка с ошибкой |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор образа, вызвавшего ошибку |
one.vm.disksnapshotrevert
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
IN | Int | Идентификатор диска, который необходимо вернуть к предыдущему состоянию |
IN | Int | Идентификатор снимка, диск которого необходимо вернуть к предыдущему состоянию |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор используемого снимка/ Строка с ошибкой |
OUT | Int | Код ошибки |
one.vm.disksnapshotrename
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор ВМ |
IN | Int | Идентификатор диска |
IN | Int | Идентификатор снимка |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор ресурса/ Строка с ошибкой |
OUT | Int | Код ошибки |
one.vm.attach
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
IN | String | Строка, содержащая параметр блока DISK. Синтаксис может быть стандартным attribute=value или в формате XML |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор ресурса/ Строка с ошибкой |
OUT | Int | Код ошибки |
one.vm.detach
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
IN | Int | Идентификатор диска |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор ресурса/ Строка с ошибкой |
OUT | Int | Код ошибки |
one.vm.diskresize
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
IN | Int | Идентификатор диска |
IN | String | Строка нового размера |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор ресурса/ Строка с ошибкой |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор образа, вызвавшего ошибку |
one.vm.attachnic
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
IN | String | Строка, содержащая векторный параметр единичного блока DISK. Синтаксис может быть стандартным |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор ресурса/ Строка с ошибкой |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор ВМ, вызвавшей ошибку |
one.vm.detachnic
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
IN | Int | Идентификатор сетевого интерфейса |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор ресурса/ Строка с ошибкой |
OUT | Int | Код ошибки |
one.vm.chmod
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
IN | Int | Бит прав владельца типа USE. Если установить значение |
IN | Int | Бит прав владельца типа MANAGE. Если установить значение |
IN | Int | Бит прав владельца типа ADMIN. Если установить значение |
IN | Int | Бит прав группы типа USE. Если установить значение |
IN | Int | Бит прав группы типа MANAGE. Если установить значение |
IN | Int | Бит прав группы типа ADMIN. Если установить значение |
IN | Int | Бит прочих прав типа USE. Если установить значение |
IN | Int | Бит прочих прав типа MANAGE. Если установить значение |
IN | Int | Бит прочих прав типа ADMIN. Если установить значение |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор ресурса / Строка с ошибкой |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор объекта, вызвавшего ошибку |
one.vm.chown
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
IN | Int | Идентификатор нового пользователя. Если установить значение |
IN | Int | Идентификатор новой группы. Если установить значение |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор ресурса / Строка с ошибкой |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор объекта, вызвавшего ошибку |
one.vm.rename
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
IN | String | Новое имя ВМ |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор ресурса / Строка с ошибкой |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор объекта, вызвавшего ошибку |
one.vm.snapshotcreate
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
IN | String | Новое имя снимка. Может быть пустым |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор ресурса / Строка с ошибкой |
OUT | Int | Код ошибки |
one.vm.snapshotrevert
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
IN | Int | Идентификатор снимка |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор ресурса / Строка с ошибкой |
OUT | Int | Код ошибки |
one.vm.snapshotdelete
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
IN | Int | Идентификатор снимка |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор ресурса / Строка с ошибкой |
OUT | Int | Код ошибки |
one.vm.resize
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
IN | String | Шаблон, содержащий элементы нового объема: CPU, VCPU, MEMORY. Если один из них не существует или его значение равно |
IN | Boolean | Значение |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор ресурса / Строка с ошибкой |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор ВМ/ Сервера виртуализации, вызвавшего ошибку |
one.vm.update
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
IN | String | Содержание нового шаблона пользователя. Синтаксис может быть стандартным |
IN | Int | Типы обновления шаблона:
|
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор ресурса / Строка с ошибкой |
OUT | Int | Код ошибки |
one.vm.updateconf
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
IN | String | Содержание нового шаблона. Синтаксис может быть стандартным |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор ресурса / Строка с ошибкой |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор ВМ, вызвавшей ошибку |
Поддерживаемые атрибуты:
Атрибут | Параметр |
---|---|
|
|
|
|
|
|
|
|
|
|
| Любое значение. Будет создана вариативная замена |
one.vm.recover
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
IN | Int | Операции восстановления:
|
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор ресурса / Строка с ошибкой |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор ВМ, вызвавшей ошибку |
one.vm.info
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
IN | Boolean | Необязательный флаг для расшифровки скрытой информации, доступен только для администратора |
OUT | Boolean | В зависимости от выполнения:
|
OUT | String | Информационная строка / Строка с ошибкой |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор объекта, вызвавшего ошибку |
one.vm.monitoring
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор информации мониторинга / Строка с ошибкой |
OUT | Int | Код ошибки |
Информация мониторинга возвращает список элементов ВМ. Каждый элемент ВМ состоит из XML-файла с обновленной информацией, возвращенной из пула действий.
one.vm.lock
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
IN | Int | Уровень блокировки:
|
IN | Boolean | Проверка блокировки объекта для возвращения сообщения об ошибке |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int | Идентификатор ресурса |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор объекта, вызвавшего ошибку |
OUT | String | Если |
one.vm.unlock
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int | Идентификатор ресурса |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор объекта, вызвавшего ошибку |
one.vmpool.info
- Некоторые атрибуты, такие как TEMPLATE, USER_TEMPLATE ограничены в этом вызове, так же как в one.vmpool.infoextended.
- Можно вывести диапазон из всего списка идентификаторов от первого до последнего. Для того чтобы вывести весь диапазон необходимо задать
(-1, -1)
, для извлечения диапазона от заданного идентификатора до конца списка задать(<id>, 1)
, для извлечения диапазона от начала списка до заданного идентификатора, необходимо задать(0, <id>)
, где<id>
— заданный идентификатор.
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Фильтр:
|
IN | Int | Если следующий параметр больше или равен |
IN | Int | Для значений больше или равных -1, это последний идентификатор диапазона. Значения меньше |
IN | Int | Фильтр состояния ВМ |
IN | String | Фильтр в формате |
OUT | Boolean | В зависимости от выполнения:
|
OUT | String | Версия пула ВМ с кратким описанием документов ВМ |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор объекта, вызвавшего ошибку |
Фильтр состояния может быть одним из:
Значение 7 зарезервировано для состояния FAILED.
Значение | Состояние |
---|---|
| Любое состояние, включая DONE |
| Любое состояние, исключая DONE |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
one.vmpool.infoextended
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Фильтр:
|
IN | Int | Если следующий параметр больше или равен |
IN | Int | Для значений больше или равных -1, это последний идентификатор диапазона. Значения меньше |
IN | Int | Фильтр состояния ВМ |
IN | String | Фильтр в формате |
OUT | Boolean | В зависимости от выполнения:
|
OUT | String | Версия пула ВМ с кратким описанием документов ВМ |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор объекта, вызвавшего ошибку |
Фильтр состояния может быть одним из:
Значение 7 зарезервировано для состояния FAILED.
Значение | Состояние |
---|---|
| Любое состояние, включая DONE |
| Любое состояние, исключая DONE |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|