ReadVM() Parent topic

Description

Read the information about a virtual machine.

Interface

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

Parameter

Parameter
Data Type
Description
Required?
imageGUID
GUID
The GUID of the virtual machine.
Yes

Response

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

Example Request

[GET]
https://ms.sample.securecloud.com/broker/API.svc/v3.5/vm/
      08bf1f76-a145-4bde-998c-3c5d36b73243/

Example Response

<?xml version="1.0" encoding="utf-8"?>
<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"
SecurityGroupGUID="1cb96482-1a2a-434e-aeb5-ae5d973a7d33"
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"/>
      <devices>
            <device msUID="20429344-1a3b-4676-bbc9-7b8b6db66d67"
            id="hcsp-dev-01" name="/dev/sdb" EncryptedName="/dev/sdb_ed"
            href="https://ms.sample.securecloud.com/Broker/API.svc/v3.5/device/
                  20429344-1a3b-4676-bbc9-7b8b6db66d67/"
            DeviceIndex="1" cspDeviceType="general" partitionType="mbr"
            provisionState="complete" provisionProgress="15" deviceStatus="Encrypted"
            parentGUID="581b574e-63b2-4508-8cff-31dc31f066d4"
            lastModified="2012-11-20T06:05:30.967">
                  <description/>
                  <fileSystem>ext3</fileSystem>
                  <partitionList>
                        <partition PartitionNumber="1" size="1 bit">
                              <mountPoint>/mnt/hd1</mountPoint>
                              <fileSystem>ext3</fileSystem>
                        </partition>
                        ...
                  </partitionList>
                  <volume size="1 bit">
                        <mountPoint>/mnt/hd1</mountPoint>
                  </volume>
                  <keyGen storageType="SecureCloud Server|KMIP Server"/>
            </device>
            ...
      </devices>
</vm>