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

15 мая 2024

ID 199649

Позволяет получить список всех зарегистрированных виртуальных машин клиента.

Метод:

GET /api/2.0/virtualization/tenants/{идентификатор клиента}/vms

где:

{идентификатор клиента} – идентификатор клиента в базе данных Сервера интеграции (обязательный параметр).

В случае успешного выполнения запроса REST API возвращает список виртуальных машин и сведения о каждой виртуальной машине клиента в следующем виде:

<vm id="{идентификатор в базе}" biosId={идентификатор BIOS ID} created="{дата и время}" updated="{дата и время}">

<name>{имя}</name>

<userData><![CDATA[{дополнительные сведения}]]></userData>

</vm>

где:

  • {идентификатор в базе} – идентификатор, назначенный виртуальной машине в базе данных Сервера интеграции.
  • {идентификатор BIOS ID} – идентификатор виртуальной машины (BIOS ID) в формате UUID.
  • created="{дата и время}" – дата и время регистрации виртуальной машины в базе данных Сервера интеграции в формате YYYY-MM-DDThh:mm:ss.
  • updated="{дата и время}" – дата и время обновления сведений о виртуально машине в базе данных в формате YYYY-MM-DDThh:mm:ss.
  • {имя} – имя виртуальной машины.
  • {дополнительные сведения} – дополнительная информация о виртуальной машине, внесенная в базу данных Сервера интеграции.

Коды возврата:

  • 200 (OK) – запрос выполнен успешно. В ответе возвращается список виртуальных машин клиента.
  • 403 (Forbidden) – доступ к ресурсу запрещен.
  • 404 (Not Found) VIRMT_TenantWithSpecifiedIdNotFound – клиент с указанным идентификатором не найден в базе данных Сервера интеграции.

Вам помогла эта статья?
Что нам нужно улучшить?
Спасибо за ваш отзыв, вы помогаете нам становиться лучше!
Спасибо за ваш отзыв, вы помогаете нам становиться лучше!