vCloud Standard API Query Service

The vCloud Standard API Query Service provides a quick and efficient way of searching for objects in vCloud Director. A query string is used to define what type of object to return. The API will return all objects that the user has permissions to view.

 

Schema Reference (VMware reference): https://code.vmware.com/apis/442/vcloud

Types of Queries

There are three types of queries available:

 

Query Type vCloud Documentation
User https://code.vmware.com/apis/442/vcloud-director/doc/doc/landing-user_typed-queries.html
Admin 

https://code.vmware.com/apis/442/vcloud-director/doc/doc/landing-admin_typed-queries.html

Note: Requires administrative privileges.

Extension https://code.vmware.com/apis/442/vcloud-director/doc/doc/landing-extension_typed-queries.html

 

The table below sets out examples of the query service.

 

Query Type Input Response
Typed GET
https://vcdurl/api/query?type=orgVdcStorageProfile
  • Status 200 OK
  • Returns XML representation of all storage profiles that the user has permissions to read. With href details of GUIDs.
GET
https://vcdurl/api/query?type=vAppTemplate
  • Status 200 OK
  • Returns XML representation of all vApp Templates that the user has permissions to read. With href details of the GUIDs.
Packaged GET       
https://vcdurl/api/vms/query
  • Status 200 OK
  • Returns XML representation of all VM’s that the user has permission to read. With href details of GUIDs.
GET       
https://vcdurl/api/vAppTemplates/query
  • Status 200 OK
  • Returns XML representation of all vApp Templates that the user has permissions to read. With href details of the GUIDs.

 


 

 

The page cannot be found

The page you are looking for might have been removed, had its name changed, or is temporarily unavailable. Please make sure you spelled the page name correctly or use the search box.