Виртуальный ЦОД на базе VMware

Запрос списка VM с помощью API

В предыдущих запросах использовалась конструкция https://{SITE}/api/query?type=name для вывода списка всех объектов типа name. Переделаем эту конструкцию для запроса списка VM и дополним, добавив параметры вывода и фильтр по атрибутам объектов.

Request

Отправьте GET-запрос c параметрами:

type=vm — показывать список всех объектов типа VM.
fields=name,containerName — для каждой VM показывать только атрибуты name и containerName (и по умолчанию атрибуты href).
filter=isVAppTemplate==false — показывать только развернутые VM, а шаблоны vApp отфильтровывать.

curl -k --header "Accept: application/*;version={VERSION}" --header "Authorization: Bearer {TOKEN}" --request GET "https://{SITE}/api/query?type={name}{&param}{&param ... }{&filter}"

Параметры

Фильтры

Response

Сервер вернет список виртуальных машин, URL которых отображается в XML-элементах QueryResultRecords — VMRecord в атрибутах href.

<QueryResultRecords>

   <VMRecord
      containerName="{vApp1-Name}"
      name="{VM1-Name}"
      href="https://{SITE}/api/vApp/vm-{VM1-ID}"/>

   <VMRecord
      containerName="{vApp2-Name}"
      name="{VM2-Name}"
      href="https://{SITE}/api/vApp/vm-{VM2-ID}"/>

   ...

</QueryResultRecords>

См.также

Полное описание конечных точек, методов и параметров запросов можно посмотреть по ссылке https://{SITE}/docs/.

Была ли статья полезной ?

Предыдущая статья

Создание vApp из шаблона с помощью API

Следующая статья

Подключение VM к сети с помощью API

Поддержка Юридические документы