VMware Cloud Director API - GET-VApp

VMware Cloud Director API - GET-VApp

GET /vApp/{id}

Operation:
GET /vApp/{id}
Description:
Retrieve a vApp or VM.
Since:
0.9
Input parameters
Consume media type(s):
None
Input type:
None
Output parameters
VAppType

Produce media type(s):
application/vnd.vmware.vcloud.vApp+xml
application/vnd.vmware.vcloud.vApp+json
application/vnd.vmware.vcloud.vm+xml
application/vnd.vmware.vcloud.vm+json
Output type:
javax.ws.rs.core.Response
Examples
Request
HTTP 1.1
GET /api/vApp/vapp-bba47763-0ce1-45b9-8470-ea29ba58c52f

Headers:
x-vcloud-authorization: eVBkZn2wahPAU+IvbURo7ekslpuoHERMB2DZEFlJuHs=

Body:
Response
HTTP/1.1 200 OK

Headers:
Content-Length: 26289
Content-Type: application/vnd.vmware.vcloud.vApp+xml;version=5.5
Vary: Accept-Encoding

Body:
<?xml version="1.0" encoding="UTF-8"?><VApp
    xmlns="http://www.vmware.com/vcloud/v1.5"
    xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1"
    xmlns:rasd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData"
    xmlns:vmext="http://www.vmware.com/vcloud/extension/v1.5"
    xmlns:vmw="http://www.vmware.com/schema/ovf"
    xmlns:vssd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    deployed="false"
    href="https://vcloud.example.com/api/vApp/vapp-bba47763-0ce1-45b9-8470-ea29ba58c52f"
    id="urn:vcloud:vapp:bba47763-0ce1-45b9-8470-ea29ba58c52f"
    name="importedVapp"
    ovfDescriptorUploaded="true"
    status="8"
    type="application/vnd.vmware.vcloud.vApp+xml"
    xsi:schemaLocation="http://www.vmware.com/vcloud/extension/v1.5 http://https://vcloud.example.com/api/v1.5/schema/vmwextensions.xsd http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2.22.0/CIM_VirtualSystemSettingData.xsd http://www.vmware.com/schema/ovf http://www.vmware.com/schema/ovf http://schemas.dmtf.org/ovf/envelope/1 http://schemas.dmtf.org/ovf/envelope/1/dsp8023_1.1.0.xsd http://www.vmware.com/vcloud/v1.5 http://https://vcloud.example.com/api/v1.5/schema/master.xsd http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2.22.0/CIM_ResourceAllocationSettingData.xsd">
    <Link
        href="https://vcloud.example.com/api/vApp/vapp-bba47763-0ce1-45b9-8470-ea29ba58c52f/power/action/powerOn"
        rel="power:powerOn"/>
    <Link
        href="https://vcloud.example.com/api/vApp/vapp-bba47763-0ce1-45b9-8470-ea29ba58c52f/action/deploy"
        rel="deploy"
        type="application/vnd.vmware.vcloud.deployVAppParams+xml"/>
    <Link
        href="https://vcloud.example.com/api/network/82af5cfc-1f17-40b5-bc19-e8122a599ad2"
        name="VM Network"
        rel="down"
        type="application/vnd.vmware.vcloud.vAppNetwork+xml"/>
    <Link
        href="https://vcloud.example.com/api/vApp/vapp-bba47763-0ce1-45b9-8470-ea29ba58c52f/controlAccess/"
        rel="down"
        type="application/vnd.vmware.vcloud.controlAccess+xml"/>
    <Link
        href="https://vcloud.example.com/api/vApp/vapp-bba47763-0ce1-45b9-8470-ea29ba58c52f/action/controlAccess"
        rel="controlAccess"
        type="application/vnd.vmware.vcloud.controlAccess+xml"/>
    <Link
        href="https://vcloud.example.com/api/vApp/vapp-bba47763-0ce1-45b9-8470-ea29ba58c52f/action/recomposeVApp"
        rel="recompose"
        type="application/vnd.vmware.vcloud.recomposeVAppParams+xml"/>
    <Link
        href="https://vcloud.example.com/api/vApp/vapp-bba47763-0ce1-45b9-8470-ea29ba58c52f/action/enterMaintenanceMode"
        rel="enterMaintenanceMode"/>
    <Link
        href="https://vcloud.example.com/api/vdc/afaafb99-228c-4838-ad07-5bf3aa649d42"
        rel="up"
        type="application/vnd.vmware.vcloud.vdc+xml"/>
    <Link
        href="https://vcloud.example.com/api/vApp/vapp-bba47763-0ce1-45b9-8470-ea29ba58c52f"
        rel="edit"
        type="application/vnd.vmware.vcloud.vApp+xml"/>
    <Link
        href="https://vcloud.example.com/api/vApp/vapp-bba47763-0ce1-45b9-8470-ea29ba58c52f"
        rel="remove"/>
    <Link
        href="https://vcloud.example.com/api/vApp/vapp-bba47763-0ce1-45b9-8470-ea29ba58c52f/action/enableDownload"
        rel="enable"/>
    <Link
        href="https://vcloud.example.com/api/vApp/vapp-bba47763-0ce1-45b9-8470-ea29ba58c52f/action/disableDownload"
        rel="disable"/>
    <Link
        href="https://vcloud.example.com/api/vApp/vapp-bba47763-0ce1-45b9-8470-ea29ba58c52f/owner"
        rel="down"
        type="application/vnd.vmware.vcloud.owner+xml"/>
    <Link
        href="https://vcloud.example.com/api/vApp/vapp-bba47763-0ce1-45b9-8470-ea29ba58c52f/metadata"
        rel="down"
        type="application/vnd.vmware.vcloud.metadata+xml"/>
    <Link
        href="https://vcloud.example.com/api/vApp/vapp-bba47763-0ce1-45b9-8470-ea29ba58c52f/ovf"
        rel="ovf"
        type="text/xml"/>
    <Link
        href="https://vcloud.example.com/api/vApp/vapp-bba47763-0ce1-45b9-8470-ea29ba58c52f/productSections/"
        rel="down"
        type="application/vnd.vmware.vcloud.productSections+xml"/>
    <Link
        href="https://vcloud.example.com/api/vApp/vapp-bba47763-0ce1-45b9-8470-ea29ba58c52f/action/createSnapshot"
        rel="snapshot:create"
        type="application/vnd.vmware.vcloud.createSnapshotParams+xml"/>
    <Description/>
    <LeaseSettingsSection
        href="https://vcloud.example.com/api/vApp/vapp-bba47763-0ce1-45b9-8470-ea29ba58c52f/leaseSettingsSection/"
        ovf:required="false"
        type="application/vnd.vmware.vcloud.leaseSettingsSection+xml">
        <ovf:Info>Lease settings section</ovf:Info>
        <Link
            href="https://vcloud.example.com/api/vApp/vapp-bba47763-0ce1-45b9-8470-ea29ba58c52f/leaseSettingsSection/"
            rel="edit"
            type="application/vnd.vmware.vcloud.leaseSettingsSection+xml"/>
        <DeploymentLeaseInSeconds>604800</DeploymentLeaseInSeconds>
        <StorageLeaseInSeconds>2592000</StorageLeaseInSeconds>
        <StorageLeaseExpiration>2013-03-16T13:18:35.237+02:00</StorageLeaseExpiration>
    </LeaseSettingsSection>
    <ovf:StartupSection
        xmlns:vcloud="http://www.vmware.com/vcloud/v1.5"
        vcloud:href="https://vcloud.example.com/api/vApp/vapp-bba47763-0ce1-45b9-8470-ea29ba58c52f/startupSection/"
        vcloud:type="application/vnd.vmware.vcloud.startupSection+xml">
        <ovf:Info>VApp startup section</ovf:Info>
        <ovf:Item
            ovf:id="importedVapp"
            ovf:order="0"
            ovf:startAction="powerOn"
            ovf:startDelay="0"
            ovf:stopAction="guestShutdown"
            ovf:stopDelay="0"/>
        <Link
            href="https://vcloud.example.com/api/vApp/vapp-bba47763-0ce1-45b9-8470-ea29ba58c52f/startupSection/"
            rel="edit"
            type="application/vnd.vmware.vcloud.startupSection+xml"/>
    </ovf:StartupSection>
    <ovf:NetworkSection
        xmlns:vcloud="http://www.vmware.com/vcloud/v1.5"
        vcloud:href="https://vcloud.example.com/api/vApp/vapp-bba47763-0ce1-45b9-8470-ea29ba58c52f/networkSection/"
        vcloud:type="application/vnd.vmware.vcloud.networkSection+xml">
        <ovf:Info>The list of logical networks</ovf:Info>
        <ovf:Network
            ovf:name="VM Network">
            <ovf:Description>new description</ovf:Description>
        </ovf:Network>
    </ovf:NetworkSection>
    <NetworkConfigSection
        href="https://vcloud.example.com/api/vApp/vapp-bba47763-0ce1-45b9-8470-ea29ba58c52f/networkConfigSection/"
        ovf:required="false"
        type="application/vnd.vmware.vcloud.networkConfigSection+xml">
        <ovf:Info>The configuration parameters for logical networks</ovf:Info>
        <Link
            href="https://vcloud.example.com/api/vApp/vapp-bba47763-0ce1-45b9-8470-ea29ba58c52f/networkConfigSection/"
            rel="edit"
            type="application/vnd.vmware.vcloud.networkConfigSection+xml"/>
        <NetworkConfig
            networkName="VM Network">
            <Link
                href="https://vcloud.example.com/api/admin/network/82af5cfc-1f17-40b5-bc19-e8122a599ad2/action/reset"
                rel="repair"/>
            <Description>new description</Description>
            <Configuration>
                <IpScopes>
                    <IpScope>
                        <IsInherited>false</IsInherited>
                        <Gateway>192.168.254.1</Gateway>
                        <Netmask>255.255.255.0</Netmask>
                        <IsEnabled>true</IsEnabled>
                        <IpRanges>
                            <IpRange>
                                <StartAddress>192.168.254.100</StartAddress>
                                <EndAddress>192.168.254.199</EndAddress>
                            </IpRange>
                        </IpRanges>
                    </IpScope>
                </IpScopes>
                <FenceMode>isolated</FenceMode>
                <RetainNetInfoAcrossDeployments>false</RetainNetInfoAcrossDeployments>
            </Configuration>
            <IsDeployed>false</IsDeployed>
        </NetworkConfig>
    </NetworkConfigSection>
    <SnapshotSection
        href="https://vcloud.example.com/api/vApp/vapp-bba47763-0ce1-45b9-8470-ea29ba58c52f/snapshotSection"
        ovf:required="false"
        type="application/vnd.vmware.vcloud.snapshotSection+xml">
        <ovf:Info>Snapshot information section</ovf:Info>
    </SnapshotSection>
    <DateCreated>2013-02-14T13:14:23.850+02:00</DateCreated>
    <Owner
        type="application/vnd.vmware.vcloud.owner+xml">
        <User
            href="https://vcloud.example.com/api/admin/user/51e86769-9e2d-4edc-af4e-5d3606494cbf"
            name="system"
            type="application/vnd.vmware.admin.user+xml"/>
    </Owner>
    <InMaintenanceMode>false</InMaintenanceMode>
    <Children>
        <Vm
            deployed="false"
            href="https://vcloud.example.com/api/vApp/vm-89c84bd6-c6f2-4e4c-8a7d-c44a3489e2e4"
            id="urn:vcloud:vm:89c84bd6-c6f2-4e4c-8a7d-c44a3489e2e4"
            name="importedVapp"
            needsCustomization="false"
            status="8"
            type="application/vnd.vmware.vcloud.vm+xml">
            <VCloudExtension
                required="false">
                <vmext:VmVimInfo>
                    <vmext:VmVimObjectRef>
                        <vmext:VimServerRef
                            href="https://vcloud.example.com/api/admin/extension/vimServer/5b2f648b-9da7-4d7b-8212-6ed8a83f2102"
                            name="ConfigWizard Configured vCenter"
                            type="application/vnd.vmware.admin.vmwvirtualcenter+xml"/>
                        <vmext:MoRef>vm-277</vmext:MoRef>
                        <vmext:VimObjectType>VIRTUAL_MACHINE</vmext:VimObjectType>
                    </vmext:VmVimObjectRef>
                    <vmext:DatastoreVimObjectRef>
                        <vmext:VimServerRef
                            href="https://vcloud.example.com/api/admin/extension/vimServer/5b2f648b-9da7-4d7b-8212-6ed8a83f2102"
                            name="ConfigWizard Configured vCenter"
                            type="application/vnd.vmware.admin.vmwvirtualcenter+xml"/>
                        <vmext:MoRef>datastore-42</vmext:MoRef>
                        <vmext:VimObjectType>DATASTORE</vmext:VimObjectType>
                    </vmext:DatastoreVimObjectRef>
                    <vmext:HostVimObjectRef>
                        <vmext:VimServerRef
                            href="https://vcloud.example.com/api/admin/extension/vimServer/5b2f648b-9da7-4d7b-8212-6ed8a83f2102"
                            name="ConfigWizard Configured vCenter"
                            type="application/vnd.vmware.admin.vmwvirtualcenter+xml"/>
                        <vmext:MoRef>host-118</vmext:MoRef>
                        <vmext:VimObjectType>HOST</vmext:VimObjectType>
                    </vmext:HostVimObjectRef>
                    <vmext:VirtualDisksMaxChainLength>3</vmext:VirtualDisksMaxChainLength>
                </vmext:VmVimInfo>
            </VCloudExtension>
            <Link
                href="https://vcloud.example.com/api/vApp/vm-89c84bd6-c6f2-4e4c-8a7d-c44a3489e2e4/power/action/powerOn"
                rel="power:powerOn"/>
            <Link
                href="https://vcloud.example.com/api/vApp/vm-89c84bd6-c6f2-4e4c-8a7d-c44a3489e2e4/action/deploy"
                rel="deploy"
                type="application/vnd.vmware.vcloud.deployVAppParams+xml"/>
            <Link
                href="https://vcloud.example.com/api/vApp/vm-89c84bd6-c6f2-4e4c-8a7d-c44a3489e2e4"
                rel="edit"
                type="application/vnd.vmware.vcloud.vm+xml"/>
            <Link
                href="https://vcloud.example.com/api/vApp/vm-89c84bd6-c6f2-4e4c-8a7d-c44a3489e2e4"
                rel="remove"/>
            <Link
                href="https://vcloud.example.com/api/vApp/vm-89c84bd6-c6f2-4e4c-8a7d-c44a3489e2e4/metadata"
                rel="down"
                type="application/vnd.vmware.vcloud.metadata+xml"/>
            <Link
                href="https://vcloud.example.com/api/vApp/vm-89c84bd6-c6f2-4e4c-8a7d-c44a3489e2e4/complianceResult"
                rel="down"
                type="application/vnd.vmware.vm.complianceResult+xml"/>
            <Link
                href="https://vcloud.example.com/api/vApp/vm-89c84bd6-c6f2-4e4c-8a7d-c44a3489e2e4/productSections/"
                rel="down"
                type="application/vnd.vmware.vcloud.productSections+xml"/>
            <Link
                href="https://vcloud.example.com/api/vApp/vm-89c84bd6-c6f2-4e4c-8a7d-c44a3489e2e4/screen"
                rel="screen:thumbnail"/>
            <Link
                href="https://vcloud.example.com/api/vApp/vm-89c84bd6-c6f2-4e4c-8a7d-c44a3489e2e4/media/action/insertMedia"
                rel="media:insertMedia"
                type="application/vnd.vmware.vcloud.mediaInsertOrEjectParams+xml"/>
            <Link
                href="https://vcloud.example.com/api/vApp/vm-89c84bd6-c6f2-4e4c-8a7d-c44a3489e2e4/media/action/ejectMedia"
                rel="media:ejectMedia"
                type="application/vnd.vmware.vcloud.mediaInsertOrEjectParams+xml"/>
            <Link
                href="https://vcloud.example.com/api/vApp/vm-89c84bd6-c6f2-4e4c-8a7d-c44a3489e2e4/disk/action/attach"
                rel="disk:attach"
                type="application/vnd.vmware.vcloud.diskAttachOrDetachParams+xml"/>
            <Link