REST API - GET Virtual Machines

This operation returns a list of virtual machines.

Request

Syntax

GET webservice/VM HTTP/1.1
Host: host name
Accept: application/xml | application/json
Authtoken: authentication token
PagingInfo: page number and number of records

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Headers

Name	Description
Host	The host name of the Web Server or Web Console used in the API request.
Accept	The format of the response. Valid values are: application/xml or application/json.
Authtoken	The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.
PagingInfo	a,b Where: a is the page number b is the number of records in a page

Response

Response Parameters

Parameter	Description	Element
vmHost	The host name for the computer where the source virtual machine or instance resides.	vmStatusInfoList
vmGuestSpace	The actual space used on the storage volume for the virtual machine, instance, or container. For Linux virtual machines, the Guest Size appears as 0.	vmStatusInfoList
bkpStartTime	The date and time that the backup of the VM, instance, or container began. Valid values are UNIX-style timestamps (seconds since January 1, 1970).	vmStatusInfoList
vmStatus	The status of the backup for the VM, instance, or container.	vmStatusInfoList
vmBackupJob		vmStatusInfoList
strOSName	The operating system version for the VM or instance.	vmStatusInfoList
isDeleted	Indicates whether or not the VM was deleted from the hypervisor. Valid values are true/false.	vmStatusInfoList
vendor	The hypervisor where the VM is located.	vmStatusInfoList
osType	The operating system installed on the VM.	vmStatusInfoList
vmSize	The total space allocated for the virtual machine, calculated as the sum of the maximum disk sizes for all of the hard disks for the virtual machine.	vmStatusInfoList
vmUsedSpace	The total space occupied on the disk.	vmStatusInfoList
subclientId	The system-generated ID assigned to the subclient.	vmStatusInfoList
subclientName	The name of the subclient.	vmStatusInfoList
bkpEndTime	The date and time that the backup of the VM, instance, or container finished. Valid values are UNIX-style timestamps (seconds since January 1, 1970).	vmStatusInfoList
vmAgent	The name of the VSA proxy that performed the backup.	vmStatusInfoList
name	The display name of the VM.	vmStatusInfoList
vmHardwareVer	The hardware version of the VM.	vmStatusInfoList
strGUID	The globally unique identifier for the VM client.	vmStatusInfoList
clientId	The system-generated ID assigned to the virtual machine.	client
clientName	The name of the virtual machine.	client
clientId	The system-generated ID assigned to the proxy client.	proxyClient
clientName	The name of the proxy client.	proxyClient
clientId	The system-generated ID assigned to the virtualization client.	pseudoClient
clientName	The name of the virtualization client.	pseudoClient

Examples

Sample Request

GET webservice/VM HTTP/1.1
Host: client.mydomain.com
Accept: application/json
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

{ "totalRecords": 4, "pageNo": 0, "errorMessage": "", "errorCode": 0, "pageSize": 100, "vmStatusInfoList": [ { "vmHost": "172.19.116.30", "vmGuestSpace": 6442642704, "bkpStartTime": 1537826493, "type": 9, "vmStatus": 1, "vmBackupJob": 2159, "strOSName": "CentOS 4/5 or later (64-bit)", "isDeleted": false, "vendor": 1, "osType": 2, "vmSize": 6442642704, "vmUsedSpace": 191889408, "subclientId": 10, "bkpEndTime": 1537826609, "vmAgent": "vkprime", "name": "ty-vm", "vmHardwareVer": "vmx-09", "strGUID": "502d21a1-ae8b-a75e-exam-313ccc60ea03", "subclientName": "replication_api", "client": { "clientId": 4, "clientName": "ty-vm" }, "proxyClient": { "clientId": 2, "clientName": "vkprime" }, "plan": {}, "pseudoClient": { "clientId": 3, "clientName": "vsa-vc65.mycompany.com", "flags": { "disabled": false } } }, { "vmHost": "172.19.110.73", "vmGuestSpace": 11335602176, "bkpStartTime": 1538495626, "type": 9, "vmStatus": 1, "vmBackupJob": 2247, "strOSName": "Microsoft Windows Server 2012 (64-bit)", "isDeleted": true, "vendor": 1, "osType": 1, "vmSize": 42950022432, "vmUsedSpace": 11562647552, "subclientId": 14, "bkpEndTime": 1538496277, "vmAgent": "vkprime", "name": "N3-VM3-test1", "vmHardwareVer": "vmx-11", "strGUID": "502d1699-exam-fdc3-37c9-421vvvv3244a", "subclientName": "no_rep_subclient", "client": { "clientId": 9, "clientName": "N3-VM3-test1" }, "proxyClient": { "clientId": 2, "clientName": "vkprime" }, "plan": {}, "pseudoClient": { "clientId": 3, "clientName": "vsa-vc65.mycompany.com", "flags": { "disabled": false } } } ]
}