/ DOCS
Облако VMware
Тема интерфейса
Виртуальный ЦОД на базе VMware

Запрос списка vApp

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

Запрос списка vApp

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

  • type=vApp — показывать список всех объектов типа vApp;

  • fields=name,numberOfCpus — для каждого vApp показывать только атрибуты name, numberOfCpus и по умолчанию атрибуты href;

  • filter=((isExpired==false)) — показывать только vApp с неистекшим сроком действия.

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

Ответ

Сервер возвращает список vApp организации в JSON-элементах.

{
   "otherAttributes": {},
   "link": [
     {
       "otherAttributes": {},
       "href": "https://{SITE}/api/query?type=vApp&page=1&pageSize=25&format=references&filter=((isExpired==false))",
       "id": null,
       "type": "application/vnd.vmware.vcloud.query.references+xml",
       "name": null,
       "rel": "alternate",
       "model": null,
       "vCloudExtension": []
     },
     {
       "otherAttributes": {},
       "href": "https://{SITE}/api/query?type=vApp&page=1&pageSize=25&format=references&filter=((isExpired==false))",
       "id": null,
       "type": "application/vnd.vmware.vcloud.query.references+json",
       "name": null,
       "rel": "alternate",
       "model": null,
       "vCloudExtension": []
     },
     {
       "otherAttributes": {},
       "href": "https://{SITE}/api/query?type=vApp&page=1&pageSize=25&format=idrecords&filter=((isExpired==false))",
       "id": null,
       "type": "application/vnd.vmware.vcloud.query.idrecords+xml",
       "name": null,
       "rel": "alternate",
       "model": null,
       "vCloudExtension": []
     },
     {
       "otherAttributes": {},
       "href": "https://{SITE}/api/query?type=vApp&page=1&pageSize=25&format=idrecords&filter=((isExpired==false))",
       "id": null,
       "type": "application/vnd.vmware.vcloud.query.idrecords+json",
       "name": null,
       "rel": "alternate",
       "model": null,
       "vCloudExtension": []
     }
   ],
   "href": "https://{SITE}/api/query?type=vApp&page=1&pageSize=25&format=records&filter=((isExpired==false))",
   "type": "application/vnd.vmware.vcloud.query.records+json",
   "name": "vApp",
   "page": 1,
   "pageSize": 25,
   "total": 2,
   "record": [
     {
       "_type": "QueryResultVAppRecordType",
       "link": [],
       "metadata": null,
       "href": "https://{SITE}/api/vApp/{VAPP-ID}",
       "id": null,
       "type": null,
       "otherAttributes": {
         "cpuAllocationMhz": "2",
         "lowestHardwareVersionInVApp": "19",
         "isAutoDeleteNotified": "false",
         "isVdcEnabled": "true",
         "honorBootOrder": "false",
         "storageKB": "12582912",
         "pvdcHighestSupportedHardwareVersion": "19",
         "isAutoUndeployNotified": "false",
         "numberOfVMs": "1",
         "cpuAllocationInMhz": "6000"
       },
       "name": "vapp-name1",
       "vdc": "https://{SITE}/api/vdc/{VDC-ID}",
       "vdcName": "vdc-name",
       "description": null,
       "isPublic": false,
       "isEnabled": true,
       "isBusy": false,
       "creationDate": "2025-03-19T11:42:22.887+0300",
       "status": "POWERED_ON",
       "ownerName": "system",
       "memoryAllocationMB": 2048,
       "isDeployed": true,
       "isInMaintenanceMode": false,
       "isAutoNature": false,
       "isExpired": false,
       "numberOfCpus": 2,
       "snapshot": false,
       "snapshotCreated": null,
       "totalStorageAllocatedMb": 14336,
       "hasOnlyReplicationModeVms": false,
       "appId": "app-id",
       "appTemplateId": null,
       "version": "vcd-ch-app-ver:1.0.0:12345",
       "logo": null,
       "appTemplateName": null
     },
     {
       "_type": "QueryResultVAppRecordType",
       "link": [],
       "metadata": null,
       "href": "https://{SITE}/api/vApp/{VAPP-ID}",
       "id": null,
       "type": null,
       "otherAttributes": {
         "cpuAllocationMhz": "2",
         "lowestHardwareVersionInVApp": "19",
         "isAutoDeleteNotified": "false",
         "isVdcEnabled": "true",
         "honorBootOrder": "false",
         "storageKB": "12582912",
         "pvdcHighestSupportedHardwareVersion": "19",
         "isAutoUndeployNotified": "false",
         "numberOfVMs": "1",
         "cpuAllocationInMhz": "6000"
       },
       "name": "vapp-name2",
       "vdc": "https://{SITE}/api/vdc/{VDC-ID}",
       "vdcName": "vdc-name",
       "description": null,
       "isPublic": false,
       "isEnabled": true,
       "isBusy": false,
       "creationDate": "2025-03-19T11:43:01.286+0300",
       "status": "POWERED_ON",
       "ownerName": "system",
       "memoryAllocationMB": 2048,
       "isDeployed": true,
       "isInMaintenanceMode": false,
       "isAutoNature": false,
       "isExpired": false,
       "numberOfCpus": 2,
       "snapshot": false,
       "snapshotCreated": null,
       "totalStorageAllocatedMb": 14336,
       "hasOnlyReplicationModeVms": false,
       "appId": "app-id",
       "appTemplateId": null,
       "version": "vcd-ch-app-ver:1.0.0:12345",
       "logo": null,
       "appTemplateName": null
     }
   ],
   "vCloudExtension": []
 }
См.также

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

Предыдущая статья
Запрос объектов виртуального ЦОД с помощью API
Следующая статья
Создание vApp из шаблона с помощью API
Была ли эта статья полезна?
Поддержка Юридические документы
© 2025 Cloud.ru