ListVM() Parent topic

Description

Obtain a list of virtual machines from the inventory.

Interface

https://[SecureCloudService]/broker/API.svc/v3.5/vm/
Method: GET

Request

N/A

Response

Expected HTTP response code: 200 (OK)
Refer to the following data types: VM and VMList.

Example Request URL

[GET]
https://ms.sample.securecloud.com/broker/API.svc/v3.5/vm

Example Response

<?xml version="1.0" encoding="utf-8"?>
<vmList version="3.5">
      <vms>
            <vm imageGUID="08bf1f76-a145-4bde-998c-3c5d36b73243"
            imageID="hcsp-img-01" imageName="" instanceID=""
            instanceGUID="00000000-0000-0000-0000-000000000000"
            autoProvision="off" nonEncryptedDeviceCount="0"
            pendingDeviceCount="0" encryptingDeviceCount="0"
            encryptedDeviceCount="0" detectedKeyCount="0"
            href="https://ms.sample.securecloud.com/Broker/API.svc/v3.5/vm/
                  08bf1f76-a145-4bde-998c-3c5d36b73243/"
            lastModified="2012-11-01T02:31:40.95">
                  <imageDescription/>
                  <provider name="HCSP" providerLocation="jp"/>
                  <platform>Linux_32</platform>
                  <securecloudAgent agentVersion="" agentStatus="offline"
                  lastHeartbeat="2012-11-01T02:31:40.95"/>
            </vm>
            ...
      </vms>
</vmList>