Loading...

REST API - GET Virtual Machine User Interface IDs

This operation returns virtual machine (VM) group information that is available in a virtual client .

Request

Syntax

GET <webservice>/v2/vsa/vmGroups/{vmgroupID} HTTP/1.1
Host: <host name>
Accept: {application/json}
Content-type: application/json

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 Parameters

Name

Description

vmgroupID

The ID of the virtual group. If the virtual group is not known, use the GET Virtual Group IDs to retrieve it.

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 value is application/json.

Content-type

The media type contained in the request body. Valid value is application/json.

Response

Response Parameters

Parameter

Description

vmGroupInfo

 

vmGroupId

The unique ID of the VM group.

clientName

 

vmGroupName

The name of the VM group.

planName

The name of the plan.

lastBackupTime

Time of the last backup.

vmBackupInfo

 

vmPendingCount

 

vmProtectedCount

 

vmNotProtectedCount

 

vmNeverBackedUpCount

 

vmBackedUpWithErrorCount

 

vmTotalCount

 

vmSLAInfo

 

vmExcludedCount

 

vmMetSLACount

 

vmMissedSLACount

 

equalsOrNotEquals

 

path

 

displayName

 

name

This is the virtual machine user interface ID.

allOrAnyChildren

 

type

 

Examples

Sample Request

GET <webservice>/v2/vsa/vmGroups/521 HTTP/1.1
Host: client.mydomain.com
Accept: application/json
Content-type: application/json

Sample Response

{
  "vmGroupInfo": [{
    "vmGroupId": 521,
    "clientName": "VMWare_Client",
    "vmGroupName": "VMWare LiveSyncDirect",
    "planName": "Plan_1",
    "lastBackupTime": 0,
    "vmBackupInfo": {
      "vmPendingCount": 0,
      "vmProtectedCount": 0,
      "vmNotProtectedCount": 0,
      "vmNeverBackedUpCount": 0,
      "vmBackedUpWithErrorCount": 0,
      "vmTotalCount": 0
    },
    "vmSLAInfo": {
      "vmExcludedCount": 3,
      "vmMetSLACount": 0,
      "vmMissedSLACount": 0
    },
    "content": {
      "children": [{
        "equalsOrNotEquals": true,
        "path": "",
        "displayName": "LiveSyncDirectVM1",
        "name": "5026b5cc-1f53-bd8b-2a79-9bf6ee9bc9a4",
        "allOrAnyChildren": true,
        "type": 9
      }, {
        "equalsOrNotEquals": true,
        "path": "",
        "displayName": "LiveSyncDirectVM10",
        "name": "5026f812-cb97-9cef-8152-cecf8c05b150",
        "allOrAnyChildren": true,
        "type": 9
      }, {
        "equalsOrNotEquals": true,
        "path": "",
        "displayName": "LiveSyncDirectVM2",
        "name": "5026d5cb-b72a-b901-72a2-9a5bb38878dd",
        "allOrAnyChildren": true,
        "type": 9
      }]
    }
  }]
}

Last modified: 4/21/2020 3:20:51 PM