VMware Cloud Director API - GET-ExecuteQuery
GET /query
- Operation:
- GET /query
- Description:
- REST API General queries handler
- Since:
- 1.5
- Federated:
- Yes
- Input parameters
-
- Consume media type(s):
- None
- Input type:
- None
- Query parameters
-
- Parameter
- type
- Documentation
- Parameter
- filter
- Documentation
- Parameter
- sortAsc
- Documentation
- Parameter
- sortDesc
- Documentation
- Parameter
- format
- Documentation
- Parameter
- page
- Documentation
- Parameter
- pageSize
- Documentation
- Parameter
- offset
- Documentation
- Parameter
- fields
- Documentation
- Parameter
- links
- Documentation
- Output parameters
-
Returns result of the query executed with provided filter in xml format.
- Produce media type(s):
-
application/vnd.vmware.vcloud.query.records+xml
application/vnd.vmware.vcloud.query.records+json
application/vnd.vmware.vcloud.query.idrecords+xml
application/vnd.vmware.vcloud.query.idrecords+json
application/vnd.vmware.vcloud.query.references+xml
application/vnd.vmware.vcloud.query.references+json
application/vnd.vmware.vcloud.query.queryList+xml
application/vnd.vmware.vcloud.query.queryList+json
- Output type:
- T extends com.vmware.vcloud.api.rest.schema_v1_5.ContainerType
- Examples
-
-
Get query list.
- Request
-
HTTP 1.1
GET /api/query
Headers:
x-vcloud-authorization: M69zc2o7Ol7AuYVBAslGYbnTluZZVZKIYa1HPe8MzEk=
Body:
- Response
-
HTTP/1.1 200 OK
Headers:
Content-Length: 30280
Content-Type: application/vnd.vmware.vcloud.query.querylist+xml;version=5.5
Vary: Accept-Encoding
Body:
<?xml version="1.0" encoding="UTF-8"?><QueryList
xmlns="http://www.vmware.com/vcloud/v1.5"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
href="https://vcloud.example.com/api/query"
type="application/vnd.vmware.vcloud.query.queryList+xml"
xsi:schemaLocation="http://www.vmware.com/vcloud/v1.5 http://https://vcloud.example.com/api/v1.5/schema/master.xsd">
<Link href="https://vcloud.example.com/api/query?type=organization&format=references" name="organization" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
<Link href="https://vcloud.example.com/api/query?type=organization&format=records" name="organization" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
<Link href="https://vcloud.example.com/api/query?type=organization&format=idrecords" name="organization" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
<Link href="https://vcloud.example.com/api/query?type=adminOrgNetwork&format=references" name="adminOrgNetwork" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
<Link href="https://vcloud.example.com/api/query?type=adminOrgNetwork&format=records" name="adminOrgNetwork" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
<Link href="https://vcloud.example.com/api/query?type=adminOrgNetwork&format=idrecords" name="adminOrgNetwork" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
<Link href="https://vcloud.example.com/api/query?type=adminOrgVdc&format=references" name="adminOrgVdc" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
<Link href="https://vcloud.example.com/api/query?type=adminOrgVdc&format=records" name="adminOrgVdc" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
<Link href="https://vcloud.example.com/api/query?type=adminOrgVdc&format=idrecords" name="adminOrgVdc" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
<Link href="https://vcloud.example.com/api/query?type=providerVdc&format=references" name="providerVdc" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
<Link href="https://vcloud.example.com/api/query?type=providerVdc&format=records" name="providerVdc" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
<Link href="https://vcloud.example.com/api/query?type=providerVdc&format=idrecords" name="providerVdc" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
<Link href="https://vcloud.example.com/api/query?type=externalNetwork&format=references" name="externalNetwork" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
<Link href="https://vcloud.example.com/api/query?type=externalNetwork&format=records" name="externalNetwork" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
<Link href="https://vcloud.example.com/api/query?type=externalNetwork&format=idrecords" name="externalNetwork" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
<Link href="https://vcloud.example.com/api/query?type=strandedUser&format=references" name="strandedUser" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
<Link href="https://vcloud.example.com/api/query?type=strandedUser&format=records" name="strandedUser" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
<Link href="https://vcloud.example.com/api/query?type=strandedUser&format=idrecords" name="strandedUser" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
<Link href="https://vcloud.example.com/api/query?type=role&format=references" name="role" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
<Link href="https://vcloud.example.com/api/query?type=role&format=records" name="role" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
<Link href="https://vcloud.example.com/api/query?type=role&format=idrecords" name="role" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
<Link href="https://vcloud.example.com/api/query?type=event&format=records" name="event" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
<Link href="https://vcloud.example.com/api/query?type=event&format=idrecords" name="event" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
<Link href="https://vcloud.example.com/api/query?type=resourcePool&format=records" name="resourcePool" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
<Link href="https://vcloud.example.com/api/query?type=resourcePool&format=idrecords" name="resourcePool" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
<Link href="https://vcloud.example.com/api/query?type=datastore&format=references" name="datastore" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
<Link href="https://vcloud.example.com/api/query?type=datastore&format=records" name="datastore" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
<Link href="https://vcloud.example.com/api/query?type=datastore&format=idrecords" name="datastore" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
<Link href="https://vcloud.example.com/api/query?type=networkPool&format=references" name="networkPool" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
<Link href="https://vcloud.example.com/api/query?type=networkPool&format=records" name="networkPool" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
<Link href="https://vcloud.example.com/api/query?type=networkPool&format=idrecords" name="networkPool" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
<Link href="https://vcloud.example.com/api/query?type=portgroup&format=records" name="portgroup" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
<Link href="https://vcloud.example.com/api/query?type=portgroup&format=idrecords" name="portgroup" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
<Link href="https://vcloud.example.com/api/query?type=dvSwitch&format=records" name="dvSwitch" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
<Link href="https://vcloud.example.com/api/query?type=dvSwitch&format=idrecords" name="dvSwitch" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
<Link href="https://vcloud.example.com/api/query?type=cell&format=records" name="cell" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
<Link href="https://vcloud.example.com/api/query?type=cell&format=idrecords" name="cell" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
<Link href="https://vcloud.example.com/api/query?type=virtualCenter&format=references" name="virtualCenter" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
<Link href="https://vcloud.example.com/api/query?type=virtualCenter&format=records" name="virtualCenter" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
<Link href="https://vcloud.example.com/api/query?type=virtualCenter&format=idrecords" name="virtualCenter" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
<Link href="https://vcloud.example.com/api/query?type=host&format=references" name="host" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
<Link href="https://vcloud.example.com/api/query?type=host&format=records" name="host" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
<Link href="https://vcloud.example.com/api/query?type=host&format=idrecords" name="host" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
<Link href="https://vcloud.example.com/api/query?type=adminVApp&format=references" name="adminVApp" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
<Link href="https://vcloud.example.com/api/query?type=adminVApp&format=records" name="adminVApp" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
<Link href="https://vcloud.example.com/api/query?type=adminVApp&format=idrecords" name="adminVApp" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
<Link href="https://vcloud.example.com/api/query?type=right&format=references" name="right" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
<Link href="https://vcloud.example.com/api/query?type=right&format=records" name="right" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
<Link href="https://vcloud.example.com/api/query?type=right&format=idrecords" name="right" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
<Link href="https://vcloud.example.com/api/query?type=adminVM&format=references" name="adminVM" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
<Link href="https://vcloud.example.com/api/query?type=adminVM&format=records" name="adminVM" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
<Link href="https://vcloud.example.com/api/query?type=adminVM&format=idrecords" name="adminVM" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
<Link href="https://vcloud.example.com/api/query?type=adminAllocatedExternalAddress&format=records" name="adminAllocatedExternalAddress" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
<Link href="https://vcloud.example.com/api/query?type=adminAllocatedExternalAddress&format=idrecords" name="adminAllocatedExternalAddress" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
<Link href="https://vcloud.example.com/api/query?type=vAppOrgNetworkRelation&format=references" name="vAppOrgNetworkRelation" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
<Link href="https://vcloud.example.com/api/query?type=vAppOrgNetworkRelation&format=records" name="vAppOrgNetworkRelation" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
<Link href="https://vcloud.example.com/api/query?type=vAppOrgNetworkRelation&format=idrecords" name="vAppOrgNetworkRelation" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
<Link href="https://vcloud.example.com/api/query?type=orgVdcResourcePoolRelation&format=records" name="orgVdcResourcePoolRelation" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
<Link href="https://vcloud.example.com/api/query?type=orgVdcResourcePoolRelation&format=idrecords" name="orgVdcResourcePoolRelation" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
<Link href="https://vcloud.example.com/api/query?type=providerVdcResourcePoolRelation&format=records" name="providerVdcResourcePoolRelation" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
<Link href="https://vcloud.example.com/api/query?type=providerVdcResourcePoolRelation&format=idrecords" name="providerVdcResourcePoolRelation" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
<Link href="https://vcloud.example.com/api/query?type=datastoreProviderVdcRelation&format=records" name="datastoreProviderVdcRelation" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
<Link href="https://vcloud.example.com/api/query?type=datastoreProviderVdcRelation&format=idrecords" name="datastoreProviderVdcRelation" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
<Link href="https://vcloud.example.com/api/query?type=adminUser&format=references" name="adminUser" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
<Link href="https://vcloud.example.com/api/query?type=adminUser&format=records" name="adminUser" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
<Link href="https://vcloud.example.com/api/query?type=adminUser&format=idrecords" name="adminUser" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
<Link href="https://vcloud.example.com/api/query?type=adminGroup&format=references" name="adminGroup" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
<Link href="https://vcloud.example.com/api/query?type=adminGroup&format=records" name="adminGroup" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
<Link href="https://vcloud.example.com/api/query?type=adminGroup&format=idrecords" name="adminGroup" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
<Link href="https://vcloud.example.com/api/query?type=adminVAppNetwork&format=references" name="adminVAppNetwork" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
<Link href="https://vcloud.example.com/api/query?type=adminVAppNetwork&format=records" name="adminVAppNetwork" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
<Link href="https://vcloud.example.com/api/query?type=adminVAppNetwork&format=idrecords" name="adminVAppNetwork" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
<Link href="https://vcloud.example.com/api/query?type=adminCatalog&format=references" name="adminCatalog" rel="down" type="application/vnd.vmware.vcloud.query.references+xml"/>
<Link href="https://vcloud.example.com/api/query?type=adminCatalog&format=records" name="adminCatalog" rel="down" type="application/vnd.vmware.vcloud.query.records+xml"/>
<Link href="https://vcloud.example.com/api/query?type=adminCatalog&format=idrecords" name="adminCatalog" rel="down" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
<Link href="https://vcloud.example.com/api/query?type=adminCatalogItem&format=references" name="adminCatalogItem"