Управление вирт. машинами

Команды для взаимодействия с виртуальными машинами

instance_reserve

Резервирование виртуальной машины (начало сессии, с этого момента начинается тарификация)

Запрос

Запрос

{
  "instance_reserve": {
    "connect_to_odds_feed": false,
    "vm_type": "WIN10_01"
  }
}

Описание

Ключ	Значение	Тип	Обяз-но
instance_reserve	Параметры команды	object
⊢ connect_to_odds_feed	Подключение к odds feed?	boolean
∟ vm_type	Тип виртуальной машины (мощность, ОС)	string

Успех

Пример

{
  "status": [
    2930,
    "SUCCESS",
    "INSTANCE_IS_RESERVED_SUCCESSFULLY"
  ],
  "session_id": "00000000000000000000000000000000"
}

Описание

Ключ	Значение	Тип
status	Статус ответа	array
session_id	Идентификатор сессии	string

Нет свободных виртуальных машин

Пример

{
  "status": [
    5101,
    "ERROR",
    "NO_HAVE_IDLE_INSTANCES"
  ]
}

Описание

Ключ	Значение	Тип
status	Статус ответа	array

Лимит виртуальных машин

Пример

{
  "status": [
    5102,
    "ERROR",
    "INSTANCES_LIMIT_REACHED"
  ]
}

Описание

Ключ	Значение	Тип
status	Статус ответа	array

instance_finish

Завершение работы с виртуальной машиной (завершение сессии, прекращение тарификации)

Запрос

Пример

{
  "instance_finish": {
    "session_id": "00000000000000000000000000000000"
  }
}

Описание

Ключ	Значание	Тип	Обяз-но
instance_finish	Параметры команды	object
∟ session_id	Идентификатор сессии	string

Успех

Пример

{
  "status": [
    2940,
    "SUCCESS",
    "INSTANCE_IS_FINISHED_SUCCESSFULLY"
  ],
  "session_id": "00000000000000000000000000000000",
  "body": {
    "instance_finish": {
      "duration_hours": 156.5,
      "cost": 45.7
    }
  }
}

Описание

Ключ	Значение	Тип
status	Статус ответа	array
session_id	Идентификатор сессии	string
body	Тело ответа	object
⊢ instance_finish	Подробности	object
| ⊢ duration_hours	Итоговая длительность сессии	number
| ∟ cost	Стоимость, которая будет списана с баланса	number

Сессия не найдена

Пример

{
  "status": [
    4040,
    "ERROR",
    "NOT_FOUND: session is not found"
  ],
  "session_id": "00000000000000000000000000000000"
}

Описание

Ключ	Значение	Тип
status	Статус ответа	array
session_id	Идентификатор сессии	string

Ошибка сессии

Пример

{
  "status": [
    4000,
    "ERROR",
    "BAD_REQUEST: `session_id` is wrong"
  ],
  "session_id": 0
}

Описание

Ключ	Значение	Тип
status	Статус ответа	array
session_id	Идентификатор сессии	string

instance_connect

Подключение вашего текущего WebSocket-соединения к виртуальной машине (с этого момента все отправленные вами команды начинают "пробрасываться" на бота)

Запрос

Пример

{
  "instance_connect": {
    "session_id": "00000000000000000000000000000000"
  }
}

Описание

Ключ	Значение	Тип	Обяз-но
instance_connect	Параметры команды	object
∟ session_id	Идентификатор сессии	string

Успех

Пример

{
  "status": [
    2910,
    "SUCCESS",
    "SESSION_IS_CONNECTED_SUCCESSFULLY"
  ],
  "session_id": "00000000000000000000000000000000"
}

Описание

Ключ	Значение	Тип
status	Статус ответа	array
session_id	Идентификатор сессии	string

Сессия не найдена

Пример

{
  "status": [
    4040,
    "ERROR",
    "NOT_FOUND: session is not found"
  ],
  "session_id": "00000000000000000000000000000000"
}

Описание

Ключ	Значение	Тип
status	Статус ответа	array
session_id	Идентификатор сессии	string

Ошибка сессии

Пример

{
  "status": [
    4000,
    "ERROR",
    "BAD_REQUEST: `session_id` was failed"
  ],
  "session_id": 0
}

Описание

Ключ	Значение	Тип
status	Статус ответа	array
session_id	Идентификатор сессии	string

Ошибка подключения

Пример

{
  "status": [
    4015,
    "ERROR",
    "ACCESS_DENIED: double websocket-connections with same session_id is not allowed"
  ],
  "session_id": "00000000000000000000000000000000"
}

Описание

Ключ	Значение	Тип
status	Статус ответа	array
session_id	Идентификатор сессии	string

instance_disconnect

Отключение вашего текущего WebSocket-соединения от виртуальной машины

Запрос

Пример

{
  "instance_disconnect": {
    "session_id": "00000000000000000000000000000000"
  }
}

Описание

Ключ	Значение	Тип	Обяз-но
instance_disconnect	Параметры команды	object
∟ session_id	Идентификатор сессии	string

Успех

Пример

{
  "status": [
    2920,
    "SUCCESS",
    "INSTANCE_IS_DISCONNECTED_SUCCESSFULLY"
  ],
  "session_id": "00000000000000000000000000000000"
}

Описание

Ключ	Значение	Тип
status	Статус ответа	array
session_id	Идентификатор сессии	string

Ошибка сессии

Пример

{
  "status": [
    4000,
    "ERROR",
    "BAD_REQUEST: session is not connected"
  ]
}

Описание

Ключ	Значение	Тип
status	Статус ответа	array

Нет идентификатора сессии

Пример

{
  "status": [
    4000,
    "ERROR",
    "BAD_REQUEST: `session_id` is required"
  ]
}

Описание

Ключ	Значение	Тип
status	Статус ответа	array

instances_reserved_list

Запрос списка всех зарезервированных вами виртуальных машин

Запрос

Пример

{
  "instances_reserved_list": {}
}

Успех

Пример

{
  "status": [
    2950,
    "SUCCESS",
    "INSTANCES_LIST_IS_SUCCESSFULLY_LOADED"
  ],
  "body": {
    "instances_reserved_list": {
      "00000000000000000000000000000000": {
        "started_at": "1970-01-01 00:00:00",
        "vm_type": "WIN10_01",
        "is_odds_feed_connected": 1,
        "duration_hours": 0.5,
        "cost": 0.7
      }
    }
  }
}

Описание

Ключ	Значение	Тип
status	Статус ответа	array
body	Тело ответа	object
⊢ instances_reserved_list	Список зарезервированных вирт. машин	object
| ⊢ <session_id>	Идентификатор сессии (является ключом)	string
| | ⊢ started_at	Дата / время запуска виртуальной машины	string
| | ⊢ vm_type	Тип виртуальной машины (мощность, ОС)	string
| | ⊢ is_odds_feed_connected	Подключен ли к Odds Feed?	number
| | ⊢ duration_hours	Время использования (в часах)	number
| | ∟ cost	Стоимость за использованное время	number