ListRunningVM() Parent topic

Description

Obtain a list of the virtual machines that are currently running.

Interface

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

Request

N/A

Response

Expected HTTP response code: 200 (OK)
Refer to the following data types: RunningVM, RunningVMList, RunningVMKeyRequest, DeviceKeyRequestState, and RunningVMDevice.

Example Request URL

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

Example Response

<?xml version="1.0" encoding="utf-8"?>
<runningVMList version="3.5"> 
      <runningVM imageGUID="08bf1f76-a145-4bde-998c-3c5d36b73243"
      imageID="hcsp-img-01" imageName="" autoProvision="on|off"
      instanceID="" instanceGUID="GUID" providerName="fakeCSP"
      providerLocation="fakeZone"
      SecurityGroupGUID="00000000-0000-0000-0000-000000000000"
      SecurityGroupName="" integrity="Unknown"
      lastModified="2012-11-01T02:31:40.95">
            <runningVMKeyRequest
            requestID="12345678-a145-4bde-998c-3c5d36b73243"
            requested="2012-11-01T02:31:40.95" deviceKeyRequestState="approved"
            href="https://  ms.sample.securecloud.com /Broker/API.svc/v3.5/
                  runningVM/keyRequest/12345678-a145-4bde-998c-3c5d36b73243/">
            </runningVMKeyRequest>
            <runningVMDevices>
                  <runningVMDevice deviceRequestID="GUID" allowKeyAction="true"
                  KeyDeliveryStatus="Delivered" integrity="Unknown"
                  deviceKeyRequestState="approved" >
                        <device deviceGUID="GUID" deviceID="" deviceName=""
                        deviceIndex="0" CSPDeviceType="simple" writeAccess="true"
                        size="" encryptedName="" fileSystem="">
                        </device>
                  </runningVMDevice>
                  ...
            </runningVMDevices>
      </runningVM>
      ...
</runningVMList>