В ПК СВ, через CLI, доступны только запросы XML-RPC stop, resume из действий над ВМ и .info для всех ресурсов.

Для работы с API рекомендуется использовать скрипты PyONE.

Для работы с API в ПК СВ "Брест" используется протокол XML-RPC. Каждый метод XML-RPC состоит их входных (IN) и выходных (OUT) значений.

Все ответы XML-RPC содержат следующие параметры:

Тип

Тип данных

Описание

OUT

Boolean

В зависимости от результата выполнения:

  • true — выполнено успешно;
  • false — метод не выполнен

OUT

Int/String

Идентификатор ресурса / Строка с ошибкой

OUT

Int

Код ошибки

Выходные данные всегда будут состоять из трех значений. Первое и третье значения являются фиксированными, но второе будет содержать сообщение об ошибке только в случае сбоя. В случае успешного выполнения метода возвращаемое значение может быть другого типа.

Код ошибки может принимать одно из следующих значений:

Значение

Код

Описание

0x0000

SUCCESS

Выполнено успешно

0x0100

AUTHENTICATION

Не удалось пройти аутентификацию пользователя

0x0200

AUTHORIZATION

Пользователь не авторизован для выполнения действия

0x0400

NO_EXISTS

Запрошенный ресурс не существует

0x0800

ACTION

Неправильное состояние для выполнения действия

0x1000

XML_RPC_API

Неверные параметры

0x2000

INTERNAL

Внутренняя ошибка

0x4000

ALLOCATE

Ресурс не может быть выделен

0x8000

LOCKED

Ресурс заблокирован

Каждый запрос XML-RPC должен быть аутентифицирован и авторизован.

Для этого для всех методов первым параметром необходимо указывать строку сеанса, связанную с подключенным пользователем. Она должна быть сформирована из содержимого файла ONE_AUTH, который будет иметь вид <имя пользователя>:<токен> с драйвером аутентификации "core" по умолчанию.