Описание XML-RPC API
REST API определяет набор функций, к которым разработчики могут совершать запросы и получать ответы. Взаимодействие происходит по протоколу HTTP. Преимуществом такого подхода является широкое распространение протокола HTTP, поэтому REST API можно использовать практически из любого языка программирования.
Для запросов с веб-клиентов - клиентской части социального приложения или от сайта существуют JS API и Flash-библиотека, которые более удобны и просты в использовании.
Все вызовы методов API - это GET или POST HTTP-запросы к URL с некоторым набором параметров. Кодировка результата - UTF-8.
Данные запроса могут передаваться в виде query-строки (после знака «?») при использовании метода GET, либо в теле POST-запроса. В случае GET-запроса, параметры должны быть закодированы с помощью URL encoding.
На данный момент, API не делает различий между GET- и POST -запросами. Тем не менее, существует ограничение на длину URL запроса - 2048 символов.
В каждом запросе должен присутствовать набор обязательных параметров. Также для каждой функции в ее документации определены дополнительные параметры, нужные только для этой функции. Текстовые значения параметров должны быть переданы в кодировке UTF-8. Одинаковые для всех функций параметры перечислены в таблице ниже.
Параметры функций
| Имя | Тип | Описание |
|---|---|---|
| method | string | Название вызываемого метода, например, users.getinfo; обязательный параметр |
| app_id | int | Идентификатор приложения; обязательный параметр |
| sig | string | Подпись запроса; обязательный параметр |
| session_key | string | Сессия текущего пользователя |
| uid | uint64 | Идентификатор пользователя, для которого вызывается метод; данный аргумент должен быть указан, если не указан session_key |
| secure | bool | Флаг, обозначающий, что запрос идет по защищенной схеме «сервер-сервер»; возможные значения: 1 или 0; по-умолчанию 0 |
| format | string | Формат выдачи ответа API; возможные значения: xml или json; по умолчанию json |
Параметры session_key и uid отвечают за авторизацию, то есть от лица какого пользователя происходит запрос. В зависимости от этого одна и та же функция в одном и том же приложении может возвращать немного разные результаты, например, когда один пользователь имеет доступ к различным закрытым данным, а другой нет. session_key используется для выполнения запросов по схеме «клиент-сервер», а uid - по схеме «сервер-сервер».
Сессия (session_key) получается при каждом новом сеансе работы пользователя с вашим приложением или сайтом. При последующих заходах того же пользователя это значение будет другим, поэтому сохранять его не надо. Значение session_key получается в зависимости от того, как используется REST API. Если используется API в клиенте социального приложения, session_key приходит в параметрах запроса, если интегрируются API для сайтов, сессия получается в процессе логина. В любом случае, после получения session_key, можно передать это значение на сервер, чтобы осуществлять вызовы функций API с сервера от лица текущего пользователя.
Схема клиент-сервер предназначена для случаев, когда REST API используется из клиента социального приложения, клиентского кода сайта или отдельного мобильного или desktop - приложения.
Если используется схема клиент-сервер, то в параметрах запроса secure=0 и sig рассчитывается по следующему алгоритму:
sig = md5(uid + params + private_key)
Значение params - это конкатенация пар «имя=значение» отсортированных в алфавитном порядке по «имя», где «имя» - это название параметра, передаваемого в функцию API, «значение» - значение параметра. Разделитель в конкатенации не используется. Параметр sig при расчете подписи не учитывается, все остальные параметры запроса должны учитываться при расчете.
Значение uid - идентификатор текущего пользователя приложения. Значение private_key можно взять из настроек приложения.
Схема сервер-сервер является более надежной. Некоторые запросы, которые подразумевают согласие пользователя, можно выполнить только по схеме клиент-сервер. В случае невозможности выполнения запроса по схеме сервер-сервер, вернется соответствующая ошибка.
Схема сервер-сервер использует отдельный ключ secret_key. При использовании схемы сервер-сервер, в параметрах запроса параметр secure=1 и значение параметра sig рассчитывается следующим образом:
sig = md5(params + secret_key)
В данном приложении описываются XML-RPC методы, использующиеся СГУ. Каждое описание состоит их имени метода и его входных и выходных значений.
Все ответы XML-RPC имеют общую структуру, приведенную в таблице ниже.
Структура ответов XML-RPC
| Данные | Тип данных | Описание |
|---|---|---|
| Вывод | Boolean | True или false в случае успешного или неуспешного завершения. |
| Вывод | String | Если возникает ошибка, выводится сообщение об ошибке. |
| Вывод | Int | Код ошибки. |
Вывод всегда состоит из трёх значений. Первое и третье являются фиксированными, второе содержит сообщение об ошибке только в случае сбоя. Код ошибки содержит одно из значений, приведенных в таблице ниже.
Коды ошибок
| Значение | Код | Описание |
|---|---|---|
| 0x0000 | SUCCESS | Успешный ответ |
| 0x0100 | AUTHENTICATION | Пользователь не может быть аутентифицирован. |
| 0x0200 | AUTHORIZATION | Пользователь не имеет права выполнять запрошенное действие. |
| 0x0400 | NO_EXISTS | Запрошенный ресурс не существует. |
| 0x0800 | ACTION | Ошибка состояния для выполнения действия. |
| 0x1000 | XML_RPC_API | Неверные параметры, например, параметр должен быть «1» или «2», а получено значение «3». |
| 0x2000 | INTERNAL | Внутренняя ошибка, например, ресурс не может быть загружен из БД. |
Примечание: Все методы ожидают строку сессии, связанную с подключенным пользователем, в качестве первого параметра. Она должна быть сформирована из содержимого файла ONE_AUTH, который будет <username>:<password> с драйвером аутентификации 'core' по умолчанию.
Примечание: Каждый запрос XML-RPC должен быть аутентифицирован и авторизован. См. документацию по подсистеме Auth для получения дополнительной информации. Информационные строки, возвращаемые методами one.*.info, имеют формат XML.
Мы рекомендуем вам использовать опцию -x интерфейса командной строки для сбора примеров вывода из вашей собственной инфраструктуры. Методы, которые принимают XML-шаблоны, требуют, чтобы корневым элементом был TEMPLATE. Например, этот шаблон:
NAME = abc
MEMORY = 1024
ATT1 = value1
Запросы авторизации
Горизонт-ВС-СГУ имеет интерфейс командной строки, который обертывает запросы XML-RPC. Для каждого запроса XML-RPC аутентифицируется токен сеанса, и после этого Диспетчер запросов генерирует запрос авторизации, который может включать более одной операции. В следующих таблицах документированы эти запросы от различных команд CLI.
onevm
| onevm | XML-RPC | Auth. Request |
|---|---|---|
| deploy | one.vm.deploy | VM:ADMIN |
| terminate | one.vm.action | VM:MANAGE |
| resched | one.vm.action | VM:ADMIN |
| migrate | one.vm.migrate | VM:ADMIN |
| disk-saveas | one.vm.disksaveas | VM:MANAGE |
| disk-attach | one.vm.attach | VM:MANAGE |
| disk-detach | one.vm.detach | VM:MANAGE |
| disk-resize | one.vm.diskresize | VM:MANAGE |
| nic-attach | one.vm.attachnic | VM:MANAGE |
| nic-detach | one.vm.detachnic | VM:MANAGE |
| create | one.vm.allocate | VM:CREATE |
| show | one.vm.info | VM:USE |
| chown | one.vm.chown | VM:MANAGE |
| chmod | one.vm.chmod | VM:<MANAGE/ADMIN> |
| rename | one.vm.rename | VM:MANAGE |
| snapshot-create | one.vm.snapshotcreate | VM:MANAGE |
| snapshot-delete | one.vm.snapshotdelete | VM:MANAGE |
| snapshot-revert | one.vm.snapshotrevert | VM:MANAGE |
| resize | one.vm.resize | VM:MANAGE |
| update | one.vm.update | VM:MANAGE |
| recover | one.vm.recover | VM:ADMIN |
| save | – (ruby method) | VM:MANAGE |
| updateconf | one.vm.updateconf | VM:MANAGE |
| list top | one.vmpool.info | VM:USE |
| – | one.vm.monitoring | VM:USE |
Примечание:Действие развертывания требует, чтобы пользователь, выполняющий команду, имел права администратора виртуальной машины. Этим пользователем обычно будет планировщик с учетными данными oneadmin.
Планировщик развертывает виртуальные машины на хостах, правами УПРАВЛЕНИЯ которыми обладает владелец виртуальной машины.
onetemplate
| Onetemplate command | XML-RPC | Auth. Request |
|---|---|---|
| update | one.template.update | TEMPLATE:MANAGE |
| instantiate | one.template.instantiate | TEMPLATE:USE |
| create | one.template.allocate | TEMPLATE:CREATE |
| clone | one.template.clone | TEMPLATE:CREATE |
| delete | one.template.delete | TEMPLATE:MANAGE |
| show | one.template.info | TEMPLATE:USE |
| chown | one.template.chown | TEMPLATE:MANAGE |
| chmod | one.template.chmod | TEMPLATE:<MANAGE/ADMIN> |
| rename | one.template.rename | TEMPLATE:MANAGE |
| list | one.templatepool.info | TEMPLATE:USE |
onehost
| onehost | XML-RPC | Auth. Request |
|---|---|---|
| disable | one.host.status | |
| update | one.host.update | HOST:ADMIN |
| create | one.host.allocate | |
| delete | one.host.delete | |
| one.host.rename | ||
| show | one.host.info | HOST:USE |
| list top | one.hostpool.info | HOST:USE |
Предупреждение: синхронизация onehost выполняется не ядром, а командой ruby command onehost.
onecluster
| onecluster | XML-RPC | Auth. Request |
|---|---|---|
| create | one.cluster.allocate | CLUSTER:CREATE |
| delete | one.cluster.delete | CLUSTER:ADMIN |
| update | one.cluster.update | CLUSTER:MANAGE |
| addhost | one.cluster.addhost | CLUSTER:ADMIN |
| delhost | one.cluster. | CLUSTER:ADMIN |
| adddatastore | one.cluster.adddatastore | CLUSTER:ADMIN |
| deldatastore | one.cluster.deldatastore | CLUSTER:ADMIN |
| addvnet | one.cluster.addvnet | CLUSTER:ADMIN |
| delvnet | one.cluster. | CLUSTER:ADMIN |
| rename | one.cluster.rename | CLUSTER:MANAGE |
| show | one.cluster.info | CLUSTER:USE |
| list | one.clusterpool.info | CLUSTER:USE |
onegroup
| onegroup | XML-RPC | Auth. Request |
|---|---|---|
| create | one.group.allocate | GROUP:CREATE |
| delete | one.group.delete | GROUP:ADMIN |
| show | one.group.info | GROUP:USE |
| update | one.group.update | GROUP:MANAGE |
| addadmin | one.group.addadmin | GROUP:MANAGE |
| deladmin | one.group.deladmin | GROUP:MANAGE |
| quota | one.group.quota | GROUP:ADMIN |
| list | one.grouppool.info | GROUP:USE |
| – | one.groupquota.info | – |
| defaultquota | one.groupquota.update | Ony for users in the oneadmin |
onevdc
| onevdc | XML-RPC | Auth. Request |
|---|---|---|
| create | one.vdc.allocate | VDC:CREATE |
| rename | one.vdc.rename | VDC:MANAGE |
| delete | one.vdc.delete | VDC:ADMIN |
| update | one.vdc.update | VDC:MANAGE |
| show | one.vdc.info | VDC:USE |
| list | one.vdcpool.info | VDC:USE |
| addgroup | one.vdc.addgroup | VDC:ADMIN |
| delgroup | one.vdc.delgroup | VDC:ADMIN |
| addcluster | one.vdc.addcluster | VDC:ADMIN |
| delcluster | one.vdc.delcluster | VDC:ADMIN |
| addhost | one.vdc.addhost | VDC:ADMIN |
| delhost | one.vdc.delhost | VDC:ADMIN |
| adddatastore | one.vdc.adddatastore | VDC:ADMIN |
| deldatastore | one.vdc.deldatastore | VDC:ADMIN |
| addvnet | one.vdc.addvnet | VDC:ADMIN |
| delvnet | one.vdc.delvnet | VDC:ADMIN |
onevnet
| onevnet | XML-RPC | Auth. Request |
|---|---|---|
| addar | one.vn.add_ar | NET:ADMIN |
| rmar | one.vn.rm_ar | NET:ADMIN |
| free | one.vn.free_ar | NET:MANAGE |
| reserve | one.vn.reserve | NET:USE |
| updatear | one.vn.update_ar | NET:MANAGE |
| hold | one.vn.hold | NET:MANAGE |
| release | one.vn.release | NET:MANAGE |
| update | one.vn.update | NET:MANAGE |
| create | one.vn.allocate | NET:CREATE |
| delete | one.vn.delete | NET:MANAGE |
| show | one.vn.info | NET:USE |
| chown | one.vn.chown | NET:MANAGE |
| chmod | one.vn.chmod | NET:<MANAGE/ADMIN> |
| rename | one.vn.rename | NET:MANAGE |
| list | one.vnpool.info | NET:USE |
oneuser
| oneuser command | XML-RPC | Auth. Request |
|---|---|---|
| create | one.user.allocate | USER:CREATE |
| delete | one.user.delete | USER:ADMIN |
| show | one.user.info | USER:USE |
| passwd | one.user.passwd | USER:MANAGE |
| login | one.user.login | USER:MANAGE |
| update | one.user.update | USER:MANAGE |
| chauth | one.user.chauth | USER:ADMIN |
| quota | one.user.quota | USER:ADMIN |
| chgrp | one.user.chgrp | USER:MANAGE |
| addgroup | one.user.addgroup | USER:MANAGE |
| delgroup | one.user.delgroup | USER:MANAGE |
| encode | – | – |
| list | one.userpool.info | USER:USE |
| – | one.userquota.info | – |
| defaultquota | one.userquota.update | Ony for users in the oneadmin |
onedatastore
| Onedatastore команда | XML-RPC Method | Auth. Request |
|---|---|---|
| create | one.datastore.allocate | DATASTORE:CREATE |
| delete | one.datastore.delete | DATASTORE:ADMIN |
| show | one.datastore.info | DATASTORE:USE |
| update | one.datastore.update | DATASTORE:MANAGE |
| rename | one.datastore.rename | DATASTORE:MANAGE |
| chown | one.datastore.chown | DATASTORE:MANAGE |
| chmod | one.datastore.chmod | DATASTORE:<MANAGE / ADMIN> |
| enable | one.datastore.enable | DATASTORE:MANAGE |
| list | one.datastorepool.info | DATASTORE:USE |
oneimage
| oneimage | XML-RPC | Auth. Request |
|---|---|---|
| persistent | one.image.persistent | IMAGE:MANAGE |
| enable | one.image.enable | IMAGE:MANAGE |
| chtype | one.image.chtype | IMAGE:MANAGE |
| update | one.image.update | IMAGE:MANAGE |
| create | one.image.allocate | IMAGE:CREATE |
| clone | one.image.clone | IMAGE:CREATE |
| delete | one.image.delete | IMAGE:MANAGE |
| show | one.image.info | IMAGE:USE |
| chown | one.image.chown | IMAGE:MANAGE |
| chmod | one.image.chmod | IMAGE:<MANAGE / ADMIN> |
| rename | one.image.rename | IMAGE:MANAGE |
| list | one.imagepool.info | IMAGE:USE |
onevrouter
| onevrouter | XML-RPC | Auth. Request |
|---|---|---|
| create | one.vrouter.allocate | VROUTER:CREATE |
| update | one.vrouter.update | VROUTER:MANAGE |
| instantiate | one.vrouter.instantiate | TEMPLATE:USE |
| nic-attach | one.vrouter.attachnic | VROUTER:MANAGE |
| nic-detach | one.vrouter.detachnic | VROUTER:MANAGE |
| delete | one.vrouter.delete | VROUTER:MANAGE |
| show | one.vrouter.info | VROUTER:USE |
| chown | one.vrouter.chown | VROUTER:MANAGE |
| chmod | one.vrouter.chmod | VROUTER:<MANAGE/ADMIN> |
| rename | one.vrouter.rename | VROUTER:MANAGE |
| list | one.vrouterpool.info | VROUTER:USE |
onezone
| onezone | XML-RPC | Auth. Request |
|---|---|---|
| create | one.zone.allocate | ZONE:CREATE |
| rename | one.zone.rename | ZONE:MANAGE |
| update | one.zone.update | ZONE:MANAGE |
| delete | one.zone.delete | ZONE:ADMIN |
| show | one.zone.info | ZONE:USE |
| list | one.zonepool.info | ZONE:USE |
| set | – | ZONE:USE |
onesecgroup
| onesecgroup com- | XML-RPC Method | Auth. Request |
|---|---|---|
| create | one.secgroup.allocate | SECGROUP:CREATE |
| clone | one.secgroup.clone | SECGROUP:CREATE |
| delete | one.secgroup.delete | SECGROUP:MANAGE |
| chown | one.secgroup.chown | SECGROUP:MANAGE |
| chmod | one.secgroup.chmod | SECGROUP:<MANAGE /ADMIN> |
| update | one.secgroup.update | SECGROUP:MANAGE |
| commit | one.secgroup.commit | SECGROUP:MANAGE |
| rename | one.secgroup.rename | SECGROUP:MANAGE |
| show | one.secgroup.info | SECGROUP:USE |
| list | one.secgrouppool.info | SECGROUP:USE |
onevmgroup
| onevmgroup | XML-RPC | Auth. Request |
|---|---|---|
| create | one.vmgroup.allocate | VMGROUP:CREATE |
| delete | one.vmgroup.delete | VMGROUP:MANAGE |
| chown | one.vmgroup.chown | VMGROUP:MANAGE |
| chmod | one.vmgroup.chmod | VMGROUP:<MANAGE / ADMIN> |
| update | one.vmgroup.update | VMGROUP:MANAGE |
| rename | one.vmgroup.rename | VMGROUP:MANAGE |
| show | one.vmgroup.info | VMGROUP:USE |
| list | one.vmgrouppool.info | VMGROUP:USE |
oneacl
| oneacl | XML-RPC | Auth. Request |
|---|---|---|
| create | one.acl.addrule | ACL:MANAGE |
| delete | one.acl.delrule | ACL:MANAGE |
| list | one.acl.info | ACL:MANAGE |
oneacct
| command | XML-RPC | Auth. Request |
|---|---|---|
| oneacct | one.vmpool.accounting | VM:USE |
system
| command | XML-RPC | Auth. Request |
|---|---|---|
| – | one.system.version | – |
| – | one.system.config | Ony for users in the oneadmin |
Действия для управления шаблонами
one.template.allocate
Описание: Выделяет новый шаблон в Горизонт-ВС-СГУ.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | String | A string containing the template contents. Syntax can be the usual attribute=value or |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The allocated resource ID / The error string. |
| OUT | Int | Error code. |
one.template.clone
Описание: Клонирует существующий шаблон виртуальной машины.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The ID of the template to be cloned. |
| IN | String | Name for the new template. |
| IN | Boolean | true to clone the template plus any image defined in DISK. The new IMAGE_ID is set into |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The new template ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the original object that caused the error. |
one.template.delete
Описание: Удаляет данный шаблон из пула.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | Boolean | true to delete the template plus any image defined in DISK. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that caused the error. |
one.template.instantiate
Описание: Создает экземпляр новой виртуальной машины на основе шаблона.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | String | Name for the new VM instance. If it is an empty string, Горизонт-ВС-СГУ will assign one automatically. |
| IN | Boolean | False to create the VM on pending (default), True to create it on hold. |
| IN | String | A string containing an extra template to be merged with the one being instantiated. It can be |
| IN | Boolean | true to create a private persistent copy of the template plus any image defined in DISK, and in- |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The new virtual machine ID / The error string. |
| OUT | Int | Error code. |
Примечание: Объявление поля перезаписывает шаблон. Таким образом, объявление DISK=[...] перезаписывает атрибут шаблона DISK и, как таковой, должно содержать полное определение ДИСКА.
one.template.update
Описание: Заменяет содержимое шаблона.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | String | The new template contents. Syntax can be the usual attribute=value or XML. |
| IN | Int | Update type: 0: replace the whole template. 1: Merge new template with the existing one. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
one.template.chmod
Описание: Изменяет биты разрешений шаблона.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | Int | USER USE bit. If set to -1, it will not change. |
| IN | Int | USER MANAGE bit. If set to -1, it will not change. |
| IN | Int | USER ADMIN bit. If set to -1, it will not change. |
| IN | Int | GROUP USE bit. If set to -1, it will not change. |
| IN | Int | GROUP MANAGE bit. If set to -1, it will not change. |
| IN | Int | GROUP ADMIN bit. If set to -1, it will not change. |
| IN | Int | OTHER USE bit. If set to -1, it will not change. |
| IN | Int | OTHER MANAGE bit. If set to -1, it will not change. |
| IN | Int | OTHER ADMIN bit. If set to -1, it will not change. |
| IN | Boolean | true to chmod the template plus any image defined in DISK. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that cuased the error. |
one.template.chown
Описание: Изменяет владельца шаблона.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | Int | The User ID of the new owner. If set to -1, the owner is not changed. |
| IN | Int | The Group ID of the new group. If set to -1, the group is not changed. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that cuased the error. |
one.template.rename
Описание: Переименовывает шаблон.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | String | The new name. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The VM ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that cuased the error. |
one.template.info
Описание: Извлекает информацию для шаблона.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | Boolean | optional flag to process the template and include extended information, such as the SIZE for |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | String | The information string / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that caused the error. |
one.templatepool.info
Описание: Извлекает информацию обо всех или части ресурсов в пуле.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | Filter flag |
| IN | Int | When the next parameter is >= -1 this is the Range start |
| IN | Int | For values >= -1 this is the Range end ID. Can be -1 to |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | String | The information string / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that caused the error. |
Диапазон может использоваться для извлечения подмножества пула, от идентификатора ‘start’ до идентификатора ‘end’. Чтобы получить полный пул, используйте (-1, -1); чтобы получить весь пул от определенного идентификатора до последнего, используйте (<id>, -1), а чтобы получить первые элементы с точностью до идентификатора, используйте (0, <id>).
Действия для управления виртуальной машиной
one.vm.allocate
Описание: Выделяет новую виртуальную машину в Горизонт-ВС-СГУ.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | String | A string containing the template for the vm. Syntax can be the usual attribute=value |
| IN | Boolean | False to create the VM on pending (default), True to create it on hold. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The allocated resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the Cluster that caused the error. |
one.vm.deploy
Описание: инициирует экземпляр данного vmid на целевом хосте.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | Int | The Host ID of the target host where the VM will be deployed. |
| IN | Boolean | true to enforce the Host capacity is not overcommitted. |
| IN | Int | The Datastore ID of the target system datastore where the VM will be deployed. It is optional, |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The VM ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the Datastore that cuased the error. |
one.vm.action
Описание: отправляет действие, которое должно быть выполнено на виртуальной машине.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | String | the action name to be performed, see below. |
| IN | Int | The object ID. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The VM ID / The error string. |
| OUT | Int | Error code. |
The action String must be one of the following:
- завершить-жестко
- прекратить
- сложное развертывание
- развернуть
- жесткое отключение питания
- отключение питания
- перезагрузка-жесткая
- перезагрузка
- постой
- освободить
- остановка
- приостановить
- resume
- перенесено
- незакрепленный
one.vm.migrate
Описание: переносит одну виртуальную машину (vid) на целевой хост (hid).
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | Int | the target host id (hid) where we want to migrate the vm. |
| IN | Boolean | if true we are indicating that we want livemigration, otherwise false. |
| IN | Boolean | true to enforce the Host capacity is not overcommitted. |
| IN | Int | the target system DS id where we want to migrate the vm. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The VM ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the Datastore / Host that cuased the error. |
one.vm.disksaveas
Описание: Устанавливает диск, к оторый будет сохранен в заданном образе.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | Int | Disk ID of the disk we want to save. |
| IN | String | Name for the new Image where the disk will be saved. |
| IN | String | Type for the new Image. If it is an empty string, then the default one will be used. See the existing |
| IN | Int | Id of the snapshot to export, if -1 the current image state will be used. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/Strin | gThe new allocated Image ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the Image / Datastore that cuased the error. |
one.vm.attach
Описание: Подключает новый диск к виртуальной машине
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | String | A string containing a single DISK vector attribute. Syntax can be the usual |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The VM ID / The error string. |
| OUT | Int | Error code. |
one.vm.detach
Описание: Отсоединяет диск от виртуальной машины
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | Int | The disk ID. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The VM ID / The error string. |
| OUT | Int | Error code. |
one.vm.diskresize
Описание: Изменяет размер диска виртуальной машины
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | Int | The disk ID. |
| IN | String | The new size string. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The VM ID / The error string. |
| OUT | Int | Error code. |
one.vm.attachnic
Описание: Подключает новый сетевой интерфейс к виртуальной машине
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | String | A string containing a single NIC vector attribute. Syntax can be the usual |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The VM ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the Virtual Machine that cuased the error. |
one.vm.detachnic
Описание: Отсоединяет сетевой интерфейс от виртуальной машины
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | Int | The nic ID. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The VM ID / The error string. |
| OUT | Int | Error code. |
one.vm.chmod
Описание: Изменяет биты разрешений виртуальной машины.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | Int | USER USE bit. If set to -1, it will not change. |
| IN | Int | USER MANAGE bit. If set to -1, it will not change. |
| IN | Int | USER ADMIN bit. If set to -1, it will not change. |
| IN | Int | GROUP USE bit. If set to -1, it will not change. |
| IN | Int | GROUP MANAGE bit. If set to -1, it will not change. |
| IN | Int | GROUP ADMIN bit. If set to -1, it will not change. |
| IN | Int | OTHER USE bit. If set to -1, it will not change. |
| IN | Int | OTHER MANAGE bit. If set to -1, it will not change. |
| IN | Int | OTHER ADMIN bit. If set to -1, it will not change. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that cuased the error. |
one.vm.chown
Описание: Изменение владельца виртуальной машины.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | Int | The User ID of the new owner. If set to -1, the owner is not changed. |
| IN | Int | The Group ID of the new group. If set to -1, the group is not changed. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that cuased the error. |
one.vm.rename
Описание: Переименовывает виртуальную машину
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | String | The new name. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The VM ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that cuased the error. |
one.vm.snapshotcreate
Описание: Создает новый снимок виртуальной машины
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | String | The new snapshot name. It can be empty. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The new snapshot ID / The error string. |
| OUT | Int | Error code. |
one.vm.snapshotrevert
Описание: Возвращает виртуальную машину к моментальному снимку
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | Int | The snapshot ID. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The VM ID / The error string. |
| OUT | Int | Error code. |
one.vm.snapshotdelete
Описание: Удаляет снимок виртуальной машины
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | Int | The snapshot ID. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The VM ID / The error string. |
| OUT | Int | Error code. |
one.vm.resize
Описание: Изменяет емкость виртуальной машины
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | String | Template containing the new capacity elements CPU, VCPU, MEMORY. If one of them is not |
| IN | Boolean | true to enforce the Host capacity is not overcommitted. This parameter is only acknoledged for |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/Strin | gThe VM ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the Virtual Machine / Host that cuased the error. |
one.vm.update
Описание: Заменяет пользовательский шаблон.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | String | The new user template contents. Syntax can be the usual attribute=value or XML. |
| IN | Int | Update type: 0: Replace the whole template. 1: Merge new template with the existing one. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
one.vm.updateconf
Описание: Обновляет (добавляет) набор поддерживаемых атрибутов конфигурации в шаблоне виртуальной машины
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | String | The new template contents. Syntax can be the usual attribute=value or XML. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the Virtual Machine that cuased the error. |
Поддерживаемые атрибуты:
| Attribute | Sub-attributes |
|---|---|
| OS | ARCH, MACHINE, KERNEL, INITRD, BOOTLOADER, BOOT |
| FEATURES | ACPI, PAE, APIC, LOCALTIME, HYPERV, GUEST_AGENT |
| INPUT | TYPE, BUS |
| GRAPHICS | TYPE, LISTEN, PASSWD, KEYMAP |
| RAW | DATA, DATA_VMX, TYPE |
| CONTEXT | Any value. Variable substitution will be made |
one.vm.recover
Описание: Восстанавливает зависшую виртуальную машину, ожидающую операции с драйвером. Восстановлен ие может быть выполнено путем сбоя или последующего выполнения ожидающей операции. Вам необходимо вручную проверить состояние виртуальной машины на хосте, чтобы решить, прошла ли операция успешно или нет.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | Int | Recover operation: success (1), failure (0), retry (2), delete (3), delete-recreate (4) |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the Virtual Machine that cuased the error. |
one.vm.info
Описание: Извлекает информацию для виртуальной машины.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | String | The information string / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the VM / DS / Cluster / Host that caused the error. |
one.vm.monitoring
Описание: Возвращает записи мониторинга виртуальной машины.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | String | The monitoring information string / The error string. |
| OUT | Int | Error code. |
Возвращаемая информация мониторинга представляет собой список элементов виртуальной машины. Каждый элемент виртуальной машины содержит полный XML виртуальной машины с обновленной информацией, возвращаемой действием опроса.
one.vmpool.info
Описание: Извлекает информацию для всех или части виртуальных машин в пуле.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | Filter flag |
| IN | Int | When the next parameter is >= -1 this is the Range start |
| IN | Int | For values >= -1 this is the Range end ID. Can be -1 to |
| IN | Int | VM state to filter by. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | String | The information string / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that caused the error. |
Диапазон может использоваться для извлечения подмножества пула, от идентификатора ‘start’ до идентификатора ‘end’. Чтобы получить полный пул, используйте (-1, -1); чтобы получить весь пул от определенного идентификатора до последнего, используйте (<id>, -1), а чтобы получить первые элементы с точностью до идентификатора, используйте (0, <id>).
Фильтр состояния, может быть, одним из следующих:
| Value | State |
|---|---|
| -2 | Any state, including DONE |
| -1 | Any state, except DONE |
| 0 | INIT |
| 1 | PENDING |
| 2 | HOLD |
| 3 | ACTIVE |
| 4 | STOPPED |
| 5 | SUSPENDED |
| 6 | DONE |
| 8 | POWEROFF |
| 9 | UNDEPLOYED |
| 10 | CLONING |
| 11 | CLONING_FAILURE |
one.vmpool.monitoring
Описание: Возвращает все записи мониторинга виртуальной машины.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | Filter flag |
| OUT | Boolean | true or false whenever is successful |
| OUT | String | The information string / The error |
| OUT | Int | Error code. |
one.vmpool.accounting
Описание: Возвращает записи истории виртуальной машины.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | Filter flag |
| IN | Int | Start time for the time interval. Can |
| IN | Int | End time for the time interval. Can |
| OUT | Boolean | true or false whenever is successful |
| OUT | String | The information string / The error |
| OUT | Int | Error code. |
Действия для управления хостами
one.host.allocate
Описание: Выделяет новый хост в Горизонт-ВС-СГУ
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | String | Hostname of the machine we want to add |
| IN | String | The name of the information manager (im_mad_name), this values are taken from the oned.conf |
| IN | String | The name of the virtual machine manager mad name (vmm_mad_name), this values are taken |
| IN | Int | The cluster ID. If it is -1, the default one will be used. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The allocated Host ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the Cluster that caused the error. |
one.host.delete
Описание: Удаляет данный хост из пула
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that caused the error. |
one.host.status
Описание: Устанавливает состояние хоста
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The Host ID. |
| IN | Int | 0: ENABLED |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the host that caused the error. |
one.host.update
• Описание: Заменяет содержимое шаблона хоста.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | String | The new template contents. Syntax can be the usual attribute=value or XML. |
| IN | Int | Update type: 0: Replace the whole template. 1: Merge new template with the existing one. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
one.host.rename
• Описание: Переименовывает хост.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | String | The new name. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The VM ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that cuased the error. |
one.host.info
• Описание: Извлекает информацию для хоста.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | String | The information string / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that caused the error. |
one.host.monitoring
• Описание: Возвращает записи мониторинга хоста.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | String | The monitoring information string / The error string. |
| OUT | Int | Error code. |
Возвращаемая информация мониторинга представляет собой список элементов узла. Каждый элемент узла содержит полный XML узла с обновленной информацией, возвращаемой действием опроса.
Например:
one.hostpool.info
• Описание: Извлекает информацию для всех узлов в пуле.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | String | The information string / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that caused the error. |
one.hostpool.monitoring
• Описание: Возвращает все записи мониторинга хос та.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | String | The information string / The error string. |
| OUT | Int | Error code. |
Действия по управлению кластером
one.cluster.allocate
• Описание: Выделяет новый кластер в Горизонт-ВС-СГУ.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | String | Name for the new cluster. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The allocated cluster ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the Cluster that caused the error. |
one.cluster.delete
• Описание: Удаляет данный кластер из пула.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that caused the error. |
one.cluster.update
• Описание: Заменяет содержимое шаблона кластера.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | String | The new template contents. Syntax can be the usual attribute=value or XML. |
| IN | Int | Update type: 0: Replace the whole template. 1: Merge new template with the existing one. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the Object that caused the error. |
one.cluster.addhost
• Описание: Добавляет узел в данный кластер.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The cluster ID. |
| IN | Int | The host ID. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the Cluster/host that caused the error. |
one.cluster.delhost
Описание: Удаляет хост из данного кластера.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The cluster ID. |
| IN | Int | The host ID. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the Cluster/host that caused the error. |
one.cluster.adddatastore
Описание: Добавляет хранилище данных в данный кластер.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The cluster ID. |
| IN | Int | The datastore ID. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the Cluster that caused the error. |
one.cluster.deldatastore
Описание: Удаляет хранилище данных из данного кластера.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The cluster ID. |
| IN | Int | The datastore ID. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the Cluster that caused the error. |
one.cluster.addvnet
Описание: Добавляет виртуальную сеть к данному кластеру.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The cluster ID. |
| IN | Int | The vnet ID. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the Cluster that caused the error. |
one.cluster.delvnet
Описание: Удаляет виртуальную сеть из данного кластера.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The cluster ID. |
| IN | Int | The vnet ID. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the Cluster that caused the error. |
one.cluster.rename
Описание: Переименовывает кластер.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | String | The new name. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The VM ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the Cluster that caused the error. |
one.cluster.info
Описание: Извлекает информацию для кластера.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | String | The information string / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the Cluster that caused the error. |
one.clusterpool.info
Описание: Извлекает информацию для всех кластеров в пуле.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | String | The information string / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that caused the error. |
Действия по управлению виртуальной сетью
one.vn.allocate
Описание: Выделяет новую виртуальную сеть в Горизонт-ВС-СГУ.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | String | A string containing the template of the virtual network. Syntax can be the usual |
| IN | Int | The cluster ID. If it is -1, the default one will be used. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The allocated resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the Cluster that caused the error. |
one.vn.delete
Описание: Удаляет данную виртуальную сеть из пула.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that caused the error. |
one.vn.add_ar
Описание: Добавляет диапазоны адресов в виртуальную сеть.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | String | template of the address ranges to add. Syntax can be the usual attribute=value or XML, |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the Virtual Network that caused the error. |
one.vn.rm_ar
Описание: Удаляет диапазон адресов из виртуальной сети.
| Имя | Тип | Оп исание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | Int | ID of the address range to remove. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the Virtual Network that caused the error. |
one.vn.update_ar
Описание: Обновляет атрибуты диапазона адресов.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | String | template of the address ranges to update. Syntax can be the usual attribute=value or |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the Virtual Network that caused the error. |
one.vn.reserve
Описание: Резервирование сетевых адресов.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The virtual network to reserve from. |
| IN | String | Template, see below. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the Virtual Network that caused the error. |
Третий параметр должен быть шаблоном Горизонт-ВС-СГУ ATTRIBUTE=VALUE со следующими значениями:
| Attribute | Description | Manda- |
|---|---|---|
| SIZE | Size of the reservation | YES |
| NAME | If set, the reservation will be created in a new Virtual Network with this name | NO |
| AR_ID | ID of the AR from where to take the addresses | NO |
| NET- | Instead of creating a new Virtual Network, the reservation will be added to the existing | NO |
| MAC | First MAC address to start the reservation range [MAC, MAC+SIZE) | NO |
| IP | First IPv4 address to start the reservation range [IP, IP+SIZE) | NO |
one.vn.free_ar
Описание: Освобождает зарезервированный диапазон адресов от виртуальной сети.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | Int | ID of the address range to free. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the VNet that caused the error. |
one.vn.hold
Описание: Сохраняет аренду виртуальной сети в том виде, в каком она используется.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | String | template of the lease to hold, e.g. LEASES=[IP=192.168.0.5]. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the VNet that caused the error. |
one.vn.release
Описание: приостанавливает аренду виртуальной сети.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | String | template of the lease to release, e.g. LEASES=[IP=192.168.0.5]. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the VNet that caused the error. |
one.vn.update
Описание: Заменяет содержимое шаблона виртуальной сети.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | String | The new template contents. Syntax can be the usual attribute=value or XML. |
| IN | Int | Update type: 0: Replace the whole template. 1: Merge new template with the existing one. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the VNet that caused the error. |
one.vn.chmod
Описание: Изменяет биты разрешений виртуальной сети.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | Int | USER USE bit. If set to -1, it will not change. |
| IN | Int | USER MANAGE bit. If set to -1, it will not change. |
| IN | Int | USER ADMIN bit. If set to -1, it will not change. |
| IN | Int | GROUP USE bit. If set to -1, it will not change. |
| IN | Int | GROUP MANAGE bit. If set to -1, it will not change. |
| IN | Int | GROUP ADMIN bit. If set to -1, it will not change. |
| IN | Int | OTHER USE bit. If set to -1, it will not change. |
| IN | Int | OTHER MANAGE bit. If set to -1, it will not change. |
| IN | Int | OTHER ADMIN bit. If set to -1, it will not change. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that cuased the error. |
one.vn.chown
Описание: Изменяет владельца виртуальной сети.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | Int | The User ID of the new owner. If set to -1, the owner is not changed. |
| IN | Int | The Group ID of the new group. If set to -1, the group is not changed. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that cuased the error. |
one.vn.rename
Описание: Переименовывает виртуальную сеть.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | String | The new name. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The VM ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that cuased the error. |
one.vn.info
Описание: Извлекает информацию для виртуальной сети.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | String | The information string / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that caused the error. |
Примечание: Правила ACL не применяются к резервированиям виртуал ьной сети так же, как к обычным виртуальным сетям и другим объектам. Подробнее читайте в руководстве по документации ACL.
one.vnpool.info
Описание: Извлекает информацию для всех или части виртуальных сетей в пуле.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | Filter flag |
| IN | Int | When the next parameter is >= -1 this is the Range start |
| IN | Int | For values >= -1 this is the Range end ID. Can be -1 to |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | String | The information string / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that caused the error. |
Диапазон может использоваться для извлечения подмножества пула, от идентификатора ‘start’ до идентификатора ‘end’. Чтобы получить полный пул, используйте (-1, -1); чтобы получить весь пул от определенного идентификатора до последнего, используйте (<id>, -1), а чтобы получить первые элементы с точностью до идентификатора, используйте (0, <id>)
Примечание: Правила ACL не приме няются к резервированиям виртуальной сети так же, как к обычным виртуальным сетям и другим объектам. Подробнее читайте в руководстве по документации ACL.
Действия для управления группами безопасности
one.secgroup.allocate
Описание: Назначает новую группу безопасности в Горизонт-ВС-СГУ.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | String | A string containing the template of the security group. Syntax can be the usual |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The allocated resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the Cluster that caused the error. |
one.secgroup.clone
Описание: Клонирует существующую группу безопасности.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The ID of the security group to be cloned. |
| IN | String | Name for the new security group. |
| IN | Int | The ID of the target datastore. Optional, can be set to -1 to use the current one. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The new security group ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the original object that caused the error. |
one.secgroup.delete
Описание: Удаляет данную группу безопасности из пула.
| Type | Data Type | Description |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that caused the error. |
one.secgroup.update
Описание: Заменяет содержимое шаблона группы безопасности.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | строке сеанса. |
| IN | Int | Идентификатор объекта. |
| IN | String | новое содержимое шаблона. Синтаксис может быть обычным attribute=value или XML. |
| IN | Int | Введите обновление:0: Замените весь шаблон.1: Объединить новый шаблон с существующим. |
| OUT | OUT | true или false всякий раз, когда выполняется успешно или нет |
| OUT | Int/String | Идентификатор ресурса / строку ошибки. |
| OUT | Int | код ошибки |
one.secgroup.commit
Описание: Зафиксируйте изменения группы безопасности на связанных виртуальных машинах. Это предназначено для повторной попытки обновления виртуальных машин или повторной инициализации процесса обновления, если oned остановлен или произошел сбой после вызова one.secgroup.update.
| Имя | Т ип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | Boolean | I true the action will only operate on outdated and error VMs. False to update all VMs. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that cuased the error. |
one.secgroup.chmod
Описание: Изменяет биты разрешений группы безопасности.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | Int | USER USE bit. If set to -1, it will not change. |
| IN | Int | USER MANAGE bit. If set to -1, it will not change. |
| IN | Int | USER ADMIN bit. If set to -1, it will not change. |
| IN | Int | GROUP USE bit. If set to -1, it will not change. |
| IN | Int | GROUP MANAGE bit. If set to -1, it will not change. |
| IN | Int | GROUP ADMIN bit. If set to -1, it will not change. |
| IN | Int | OTHER USE bit. If set to -1, it will not change. |
| IN | Int | OTHER MANAGE bit. If set to -1, it will not change. |
| IN | Int | OTHER ADMIN bit. If set to -1, it will not change. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that cuased the error. |
one.secgroup.chown
Описание: Изменяет владельца группы безопасности.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | Int | The User ID of the new owner. If set to -1, the owner is not changed. |
| IN | Int | The Group ID of the new group. If set to -1, the group is not changed. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that cuased the error. |
one.secgroup.rename
Описание: Переименовывает группу безопасности.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | String | The new name. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The VM ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that cuased the error. |
one.secgroup.info
Описание: Извлекает информацию для группы безопасности.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | String | The information string / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that caused the error. |
one.secgrouppool.info
Описание: Извлекает информацию для всех или части групп безопасности в пуле.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | Filter flag |
| IN | Int | When the next parameter is >= -1 this is the Range start |
| IN | Int | For values >= -1 this is the Range end ID. Can be -1 to |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | String | The information string / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that caused the error. | |
| OUT | Int | ID of the object that |
Диапазон может использоваться для извлечения подмножества пула, от "начального" до "конечного" идентификатора. Чтобы получить полный пул, используйте (-1, -1); чтобы получить весь пул от определенного идентификатора до последнего, используйте (<id>, -1), а чтобы получить первые элементы с точностью до идентификатора, используйте (0, <id>).
Действия по управлению группой виртуальных машин
one.vmgroup.allocate
Описание: Выделяет новую группу виртуальных машин в Горизонт-ВС-СГУ.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | String | A string containing the template of the VM. Syntax can be the usual attribute=value |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The allocated resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the Cluster that caused the error. |
one.vmgroup.delete
Описание: Удаляет данную группу виртуальных машин из пула.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that caused the error. |
one.vmgroup.update
Описание: Заменяет содержимое шаблона группы виртуальных машин.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | String | The new template contents. Syntax can be the usual attribute=value or XML. |
| IN | Int | Update type: 0: Replace the whole template. 1: Merge new template with the existing one. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
one.vmgroup.chmod
Описание: Изменяет биты разрешений группы виртуальных машин.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | Int | USER USE bit. If set to -1, it will not change. |
| IN | Int | USER MANAGE bit. If set to -1, it will not change. |
| IN | Int | USER ADMIN bit. If set to -1, it will not change. |
| IN | Int | GROUP USE bit. If set to -1, it will not change. |
| IN | Int | GROUP MANAGE bit. If set to -1, it will not change. |
| IN | Int | GROUP ADMIN bit. If set to -1, it will not change. |
| IN | Int | OTHER USE bit. If set to -1, it will not change. |
| IN | Int | OTHER MANAGE bit. If set to -1, it will not change. |
| IN | Int | OTHER ADMIN bit. If set to -1, it will not change. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that cuased the error. |
one.vmgroup.chown
Описание: Меняет владельца группы виртуальных машин.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | Int | The User ID of the new owner. If set to -1, the owner is not changed. |
| IN | Int | The Group ID of the new group. If set to -1, the group is not changed. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that cuased the error. |
one.vmgroup.rename
Описание: Переименовывает группу виртуальных машин.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | String | The new name. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The VM ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that cuased the error. |
one.vmgroup.info
Описание: Извлекает информацию для группы виртуальных машин.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | String | The information string / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that caused the error. |
one.vmgrouppool.info
Описание: Извлекает информацию для всех или части групп виртуальных машин в пуле.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | Filter flag |
| IN | Int | When the next parameter is >= -1 this is the Range start |
| IN | Int | For values >= -1 this is the Range end ID. Can be -1 to |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | String | The information string / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that caused the error. |
Диапазон может использоваться для извлечения подмножества пула, от идентификатора ‘start’ до идентификатора ‘end’. Чтобы получить полный пул, используйте (-1, -1); чтобы получить весь пул от определенного идентификатора до последнего, используйте (<id>, -1), а чтобы получить первые элементы с точностью до идентификатора, используйте (0, <id>).
Действия по управлению хранилищем данных
one.datastore.allocate
Описание: Выделяет новое хранилище данных в Горизонт-ВС-СГУ.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | String | A string containing the template of the datastore. Syntax can be the usual |
| IN | Int | The cluster ID. If it is -1, the default one will be used. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The allocated resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the Cluster that caused the error. |
one.datastore.delete
Описание: Удаляет указанное хранилище данных из пула.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that caused the error. |
one.datastore.update
Описание: Заменяет содержимое шаблона хранилища данных.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | String | The new template contents. Syntax can be the usual attribute=value or XML. |
| IN | Int | Update type: 0: Replace the whole template. 1: Merge new template with the existing one. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
one.datastore.chmod
Описание: Изменяет биты разрешений хранилища данных.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | Int | USER USE bit. If set to -1, it will not change. |
| IN | Int | USER MANAGE bit. If set to -1, it will not change. |
| IN | Int | USER ADMIN bit. If set to -1, it will not change. |
| IN | Int | GROUP USE bit. If set to -1, it will not change. |
| IN | Int | GROUP MANAGE bit. If set to -1, it will not change. |
| IN | Int | GROUP ADMIN bit. If set to -1, it will not change. |
| IN | Int | OTHER USE bit. If set to -1, it will not change. |
| IN | Int | OTHER MANAGE bit. If set to -1, it will not change. |
| IN | Int | OTHER ADMIN bit. If set to -1, it will not change. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that cuased the error. |
one.datastore.chown
Описание: Изменяет владельца хранилища данных.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | Int | The User ID of the new owner. If set to -1, the owner is not changed. |
| IN | Int | The Group ID of the new group. If set to -1, the group is not changed. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that cuased the error. |
one.datastore.rename
Описание: Переименовывает хранилище данных.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | String | The new name. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that cuased the error. |
one.datastore.enable
Описание: Включает или отключает хранилище данных.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | Boolean | True for enabling, false for disabling. |
| OUT | Boolean | true or false whenever is successful or not. |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the Datastore that cuased the error. |
one.datastore.info
Описание: Извлекает информацию для хранилища данных.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | String | The information string / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that caused the error. |
one.datastorepool.info
Описание: Извлекает информацию для всех или части хранилищ данных в пуле.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | String | The information string / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that caused the error. |
Действия по управлению образами
one.image.allocate
Описание: Выделяет новый образ в Горизонт-ВС-СГУ.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | String | A string containing the template of the image. Syntax can be the usual attribute=value |
| IN | Int | The datastore ID. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The allocated resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the Datastore that caused the error. |
one.image.clone
Описание: Клонирует существующий образ.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The ID of the image to be cloned. |
| IN | String | Name for the new image. |
| IN | Int | The ID of the target datastore. Optional, can be set to -1 to use the current one. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The new image ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the original Image / DS or destination DS that caused the error. |
one.image.delete
Описание: Удаляет образ из пул а.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that caused the error. |
one.image.enable
Описание: Включает или отключает образ.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The Image ID. |
| IN | Boolean | True for enabling, false for disabling. |
| OUT | Boolean | true or false whenever is successful or not. |
| OUT | Int/String | The Image ID / The error string. |
| OUT | Int | Error code. |
one.image.persistent
Описание: Устанавливает образ как постоянный или непостоянный.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The Image ID. |
| IN | Boolean | True for persistent, false for non-persisent. |
| OUT | Boolean | true or false whenever is successful or not. |
| OUT | Int/String | The Image ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the image that caused the error. |
one.image.chtype
Описание: Изменяет тип образа.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The Image ID. |
| IN | String | New type for the Image. See the existing types in the Image template reference. |
| OUT | Boolean | true or false whenever is successful or not. |
| OUT | Int/String | The Image ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the image that caused the error. |
one.image.update
Описание: Заменяет содержимое образа
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | String | The new template contents. Syntax can be the usual attribute=value or XML. |
| IN | Int | Update type: 0: Replace the whole template. 1: Merge new template with the existing one. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
one.image.chmod
Описание: Изменяет биты разрешений образа.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | Int | USER USE bit. If set to -1, it will not change. |
| IN | Int | USER MANAGE bit. If set to -1, it will not change. |
| IN | Int | USER ADMIN bit. If set to -1, it will not change. |
| IN | Int | GROUP USE bit. If set to -1, it will not change. |
| IN | Int | GROUP MANAGE bit. If set to -1, it will not change. |
| IN | Int | GROUP ADMIN bit. If set to -1, it will not change. |
| IN | Int | OTHER USE bit. If set to -1, it will not change. |
| IN | Int | OTHER MANAGE bit. If set to -1, it will not change. |
| IN | Int | OTHER ADMIN bit. If set to -1, it will not change. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that cuased the error. |
one.image.chown
Описание: Изменяет владельца образа.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | Int | The User ID of the new owner. If set to -1, the owner is not changed. |
| IN | Int | The Group ID of the new group. If set to -1, the group is not changed. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that cuased the error. |
one.image.rename
Описание: Переименовывает образ.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | String | The new name. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The VM ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that cuased the error. |
one.image.info
Описание: Извлекает информацию для образа.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | String | The information string / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that caused the error. |
one.imagepool.info
Описание: Извлекает информацию для всех или части образа в пуле.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | Filter flag |
| IN | Int | When the next parameter is >= -1 this is the Range start |
| IN | Int | For values >= -1 this is the Range end ID. Can be -1 to |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | String | The information string / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that caused the error. |
Диапазон может использоваться для извлечения подмножества пула, от идентификатора ‘start’ до идентификатора ‘end’. Чтобы получить полный пул, используйте (-1, -1); чтобы получить весь пул от определенного идентификатора до последнего, используйте (<id>, -1), а чтобы получить первые элементы с точностью до идентификатора, используйте (0, <id>).
Действия для управления пользователями
one.user.allocate
Описание: Выделяет нового пользователя в Горизонт-ВС-СГУ
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | String | username for the new user |
| IN | String | password for the new user |
| IN | String | authentication driver for the new user. If it is an empty string, then the default (‘core’) is used |
| IN | Array | array of Group IDs. The first ID will be used as the main group. This array can be empty, in |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The allocated User ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the Group that caused the error. |
one.user.delete
Описание: Удаляет данного пользователя из пула.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that caused the error. |
one.user.passwd
Описание: Изменяет пароль для данного пользователя.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | String | The new password |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The User ID / The error string. |
| OUT | Int | Error code. |
one.user.login
Описание: Генерирует или устанавливает токен входа.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | String | The user name to generate the token for |
| IN | String | The token, if empty oned will generate one |
| IN | Int | Valid period in seconds; 0 reset the token and -1 for a non-expiring token. |
| IN | Int | Effective GID to use with this token. To use the current GID and user groups set it to -1 |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | String | The new token / The error string. |
| OUT | Int | Error code. |
one.user.update
Описание: Заменяет содержимое пользователя.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | String | The new template contents. Syntax can be the usual attribute=value or XML. |
| IN | Int | Update type: 0: Replace the whole template. 1: Merge new template with the existing one. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
one.user.chauth
Описание: Изменяет драйвер аутентификации и пароль для данного пользователя.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | String | The new authentication driver. |
| IN | String | The new password. If it is an empty string, the password is not changed. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The User ID / The error string. |
| OUT | Int | Error code. |
one.user.quota
Описание: Устанавливает ограничения пользовательских квот.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | String | The new quota template contents. Syntax can be the usual attribute=value or XML. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
one.user.chgrp
Описание: Изменяет группу данного пользователя.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The User ID. |
| IN | Int | The Group ID of the new group. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The User ID / The error string. |
| OUT | Int | Error code. |
one.user.addgroup
Описание: Добавляет пользователя во вспомогательную группу.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The User ID. |
| IN | Int | The Group ID of the new group. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The User ID / The error string. |
| OUT | Int | Error code. |
one.user.delgroup
Описание: Удаляет пользователя из дополнительной группы
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The User ID. |
| IN | Int | The Group ID. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The User ID / The error string. |
| OUT | Int | Error code. |
one.user.info
Описание: Извлекает информацию для пользователя.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. If it is -1, then the connected user’s own info info is returned |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | String | The information string / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that cuased the error. |
one.userpool.info
Описание: Извлекает информацию обо всех пользователях в пуле.
| Имя | Ти п | Описание |
|---|---|---|
| IN | String | The session string. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | String | The information string / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that cuased the error. |
one.userquota.info
Описание: Возвращает ограничения пользовательских квот по умолчанию.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | String | The quota template contents / The error string. |
| OUT | Int | Error code. |
one.userquota.update
Описание: Обновляет ограничения пользовательских квот по умолчанию.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | String | The new quota template contents. Syntax can be the usual attribute=value or XML. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | String | The quota template contents / The error string. |
| OUT | Int | Error code. |
Действия по управлению группой
one.group.allocate
Описание: Выделяет новую группу в Горизонт-ВС-СГУ.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | String | Name for the new group. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The allocated Group ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the Cluster that caused the error. |
one.group.delete
Описание: Удаляет данную группу из пула.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that caused the error. |
one.group.info
Описание: Извлекает информацию для группы.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. If it is -1, then the connected user’s group info info is returned |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | String | The information string / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that cuased the error. |
one.group.update
Описание: Заменяет содержимое шаблона группы.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | String | The new template contents. Syntax can be the usual attribute=value or XML. |
| IN | Int | Update type: 0: Replace the whole template. 1: Merge new template with the existing one. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
one.group.addadmin
Описание: Добавляет пользователя в набор администраторов группы
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The group ID. |
| IN | Int | The user ID. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
one.group.deladmin
Описание: Удаляет пользователя из набора администраторов группы
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The group ID. |
| IN | Int | The user ID. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
one.group.quota
Описание: Устанавливает ограничения групповой квоты.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | The object ID. |
| IN | String | The new quota template contents. Syntax can be the usual attribute=value or XML. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The resource ID / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the group that caused the error. |
one.grouppool.info
Описание: Извлекает информацию по всем группам в пуле.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | String | The information string / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that cuased the error. |
one.groupquota.info
Описание: Возвращает ограничения групповой квоты по умолчанию.
| Type | Data Type | Description |
|---|---|---|
| IN | String | The session string. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | String | The quota template contents / The error string. |
| OUT | Int | Error code. |
one.groupquota.обновить
Описание: Обновляет ограничения групповой квоты по умолчанию.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | String | The new quota template contents. Syntax can be the usual attribute=value or XML. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | String | The quota template contents / The error string. |
| OUT | Int | Error code. |
Действия для управления правилами ACL
one.acl.addrule
Описание: Добавляет новое правило ACL.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | String | User component of the new rule. A string containing a hex number. |
| IN | String | Resource component of the new rule. A string containing a hex number. |
| IN | String | Rights component of the new rule. A string containing a hex number. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The allocated ACL rule ID / The error string. |
| OUT | Int | Error code. |
one.acl.delrule
Описание: Удаляет правило ACL.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | ACL. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | Int/String | The ACL rule ID / The error string. |
| OUT | Int | Error code. |
one.acl.info
Описание: Возвращает полный набор правил ACL.
| Имя | Тип | Описание |
|---|---|---|
| IN | String | The session string. |
| IN | Int | ACL. |
| OUT | Boolean | true or false whenever is successful or not |
| OUT | String | The information string / The error string. |
| OUT | Int | Error code. |
| OUT | Int | ID of the object that cuased the error. |