Download PDF
Download page Методы XML-RPC для команды onevnet.
Методы XML-RPC для команды onevnet
Команда onevnet | Метод XML-RPC | Требуемые разрешения |
---|---|---|
addar | NET:ADMIN | |
rmar | NET:ADMIN | |
free | NET:MANAGE | |
reserve | NET:USE | |
updatear | NET:MANAGE | |
hold | NET:MANAGE | |
release | NET:MANAGE | |
update | NET:MANAGE | |
create | NET:CREATE [CLUSTER:ADMIN] | |
delete | NET:MANAGE | |
show | NET:USE | |
chown chgrp | NET:MANAGE [USER:MANAGE] [GROUP:USE] | |
chmod | NET:<MANAGE/ADMIN> | |
rename | NET:MANAGE | |
list | NET:USE | |
lock | NET:MANAGE | |
unlock | NET:MANAGE |
one.vn.add_ar
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
IN | String | Шаблон диапазона адресов для добавления. Синтаксис может быть стандартным attribute=value или в формате XML |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор ресурса / Строка с ошибкой |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор виртуальной сети, вызвавшей ошибку |
one.vn.rm_ar
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
IN | Int | Идентификатор диапазона адресов для удаления |
IN | Boolean | Необязательный флаг для принудительного удаления |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор ресурса / Строка с ошибкой |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор виртуальной сети, вызвавшей ошибку |
one.vn.free_ar
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
IN | Int | Идентификатор диапазона адресов для освобождения |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор ресурса / Строка с ошибкой |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор виртуальной сети, вызвавшей ошибку |
one.vn.reserve
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Виртуальная сеть для резервирования |
IN | Int | Шаблон |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор ресурса / Строка с ошибкой |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор виртуальной сети, вызвавшей ошибку |
Параметр шаблон должен соответствовать стандартному синтаксису со следующими значениями:
Параметр | Описание | Обязательный |
---|---|---|
SIZE | Размер резервирования | Да |
NAME | Имя, если этот параметр задан будет создана новая виртуальная сеть с этим именем | Нет |
AR_ID | Идентификатор диапазона адресов для резервирования | Нет |
NETWORK_ID | Идентификатор виртуальной сети для резервирования, если не задан параметр | Нет |
MAC | Первый MAC-адрес , с которого начинается диапазон резервирования | Нет |
IP | Первый IP-адрес , с которого начинается диапазон резервирования | Нет |
one.vn.update_ar
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
IN | String | Шаблон диапазона адресов для обновления. Синтаксис может быть стандартным attribute=value или в формате XML |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор ресурса / Строка с ошибкой |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор виртуальной сети, вызвавшей ошибку |
one.vn.hold
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
IN | String | Шаблон диапазона адресов для удержания, например LEASES=[IP=192.168.0.5] |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор ресурса / Строка с ошибкой |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор виртуальной сети, вызвавшей ошибку |
one.vn.release
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
IN | String | Шаблон диапазона адресов для освобождения, например LEASES=[IP=192.168.0.5] |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор ресурса / Строка с ошибкой |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор виртуальной сети, вызвавшей ошибку |
one.vn.update
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
IN | String | Содержание нового шаблона. Синтаксис может быть стандартным attribute=value или в формате XML |
IN | Int | Типы обновления шаблона:
|
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор ресурса / Строка с ошибкой |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор виртуальной сети, вызвавшей ошибку |
one.vn.allocate
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | String | Содержание шаблона новой виртуальной сети. Синтаксис может быть стандартным attribute=value или в формате XML |
IN | Int | Идентификатор кластера. Если установить значение |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор ресурса / Строка с ошибкой |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор виртуальной сети, вызвавшей ошибку |
one.vn.delete
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор ресурса / Строка с ошибкой |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор виртуальной сети, вызвавшей ошибку |
one.vn.info
Правила ACL не применяются к резервированию в виртуальной сети таким же образом, как к обычным виртуальным сетям и другим объектам.
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
OUT | Boolean | Необязательный флаг для расшифровки скрытой информации, доступен только для администратора |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Строка с информацией / Строка с ошибкой |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор объекта, вызвавшего ошибку |
one.vn.chown
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
IN | Int | Идентификатор нового владельца. Если установить значение |
IN | Int | Идентификатор новой группы. Если установить значение |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор ресурса / Строка с ошибкой |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор объекта, вызвавшего ошибку |
one.vn.chmod
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
IN | Int | Бит прав владельца типа USE. Если установить значение |
IN | Int | Бит прав владельца типа MANAGE. Если установить значение -1, этот бит не меняется |
IN | Int | Бит прав владельца типа ADMIN. Если установить значение -1, этот бит не меняется |
IN | Int | Бит прав группы типа USE. Если установить значение -1, этот бит не меняется |
IN | Int | Бит прав группы типа MANAGE. Если установить значение -1, этот бит не меняется |
IN | Int | Бит прав группы типа ADMIN. Если установить значение -1, этот бит не меняется |
IN | Int | Бит прочих прав типа USE. Если установить значение -1, этот бит не меняется |
IN | Int | Бит прочих прав типа MANAGE. Если установить значение -1, этот бит не меняется |
IN | Int | Бит прочих прав типа ADMIN.. Если установить значение -1, этот бит не меняется |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор ресурса / Строка с ошибкой |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор объекта, вызвавшего ошибку |
one.vn.rename
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
IN | String | Новое имя виртуальной сети |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Идентификатор ресурса / Строка с ошибкой |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор объекта, вызвавшего ошибку |
one.vnpool.info
Можно вывести диапазон из всего списка идентификаторов от первого до последнего. Для того чтобы вывести весь диапазон необходимо задать (-1, -1)
, для извлечения диапазона от заданного идентификатора до конца списка задать (<id>, 1)
, для извлечения диапазона от начала списка до заданного идентификатора, необходимо задать (0, <id>)
, где <id>
— заданный идентификатор.
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Фильтр:
|
IN | Int | Если следующий параметр больше или равен |
IN | Int | Для значений больше или равных -1, это последний идентификатор диапазона. Значения меньше |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int/String | Строка с информацией / Строка с ошибкой |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор объекта, вызвавшего ошибку |
one.vn.lock
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
IN | Int | Уровень блокировки:
|
IN | Boolean |
|
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int | Идентификатор ресурса |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор объекта, вызвавшего ошибку |
OUT | String | Если |
one.vn.unlock
Тип | Тип данных | Описание |
---|---|---|
IN | String | Строка сессии |
IN | Int | Идентификатор объекта |
OUT | Boolean | В зависимости от выполнения:
|
OUT | Int | Идентификатор ресурса |
OUT | Int | Код ошибки |
OUT | Int | Идентификатор объекта, вызвавшего ошибку |