VMware Cloud Director API - GET-StrandedItemsFromQuery
GET /admin/extension/strandedItems/query
- Operation:
- GET /admin/extension/strandedItems/query
- Description:
- Get list of all stranded items in the system by using REST API general QueryHandler. This is read only list and is not bound to specific states. If filter is provided it will be applied to the corresponding result set. Format determines the elements representation - references, records or idrecords. Default format is records.
- Since:
- 1.5
- Input parameters
-
- Consume media type(s):
- None
- Input type:
- None
- Query parameters
-
- 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 OkResponse
- 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
- Output type:
- ContainerType
- Examples
-
- Request
-
HTTP 1.1
GET /api/admin/extension/strandedItems/query
Headers:
x-vcloud-authorization: 65hG8hSEDXrBtkMq9ny9xR6ZHu4ElXF6CyvYMZNS73k=
Body:
- Response
-
HTTP/1.1 200 OK
Headers:
Content-Length: 1140
Content-Type: application/vnd.vmware.vcloud.query.records+xml;version=5.5
Vary: Accept-Encoding
Body:
<?xml version="1.0" encoding="UTF-8"?><QueryResultRecords xmlns="http://www.vmware.com/vcloud/v1.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" href="https://vcloud.example.com/api/admin/extension/strandedItems/query?page=1&pageSize=25&format=records" name="strandedItem" page="1" pageSize="25" total="1" type="application/vnd.vmware.vcloud.query.records+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/admin/extension/strandedItems/query?page=1&pageSize=25&format=references" rel="alternate" type="application/vnd.vmware.vcloud.query.references+xml"/>
<Link href="https://vcloud.example.com/api/admin/extension/strandedItems/query?page=1&pageSize=25&format=idrecords" rel="alternate" type="application/vnd.vmware.vcloud.query.idrecords+xml"/>
<StrandedItemRecord
deletionDate="2013-02-14T21:21:04.963+02:00"
href="https://vcloud.example.com/api/admin/extension/strandedItem/bbfe58d1-3e44-4625-af5d-008329252f68"
name="name"
numberOfPurgeAttempts="2"
vimObjectType="VM"/>
</QueryResultRecords>