REST API - GET DR Group
This operation returns a list of Disaster Recovery (DR) groups.
Request
Syntax
GET <webservice>/DRGroups HTTP/1.1
Host: <host name>
Accept: {application/xml | application/json}
Authtoken: <authentication token>
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. |
Response
Response Parameters
Parameter |
Description |
Element |
description |
Description of DR group. |
vApp |
isVirtualLab |
Valid values are True/False. |
vApp |
operationType |
The type of operation. Valid values are:
|
vApp |
vAppId |
The ID of the vApp. |
vAppEntity |
vAppName |
The name of the vApp. |
vAppEntity |
clientName |
The name of the client. |
clientList |
backupsetId |
The ID for the backupset. |
clientList |
clientId |
The system-generated ID assigned to the client. |
clientList |
GUID |
The globally unique identifier for the client or virtual machine. |
clientList |
backupsetName |
The name of the backup set. |
clientList |
entityId |
The ID of the entity. |
clientList |
Examples
Sample Request
GET <webservice>/DRGroups HTTP/1.1
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Sample Response
JSON
{
"vApp": [{
"description": "",
"isVirtualLab": false,
"operationType": 16,
"vAppEntity": {
"vAppId": 50,
"vAppName": "AdminConsoleGroup"
},
"clientList": [{
"clientName": "FGVM1",
"backupsetId": 12,
"clientId": 331,
"GUID": "50394cfc-00b5-c98b-96a9-8cda9543ac98",
"backupsetName": "defaultBackupSet",
"entityId": 32
}, {
"clientName": "ACVM1",
"backupsetId": 12,
"clientId": 412,
"GUID": "503990ee-2dee-d4fe-5f05-29a09780a239",
"backupsetName": "defaultBackupSet",
"entityId": 37
}]
}
XML
<Api_GetVirtualAppResp>
<vApp description="" isVirtualLab="0" operationType="16">
<vAppEntity vAppId="50" vAppName="AdminConsoleGroup" />
<clientList clientName="FGVM1" backupsetId="12" clientId="331" GUID="50394cfc-00b5-c98b-96a9-8cda9543ac98" backupsetName="defaultBackupSet" entityId="32" />
<clientList clientName="ACVM1" backupsetId="12" clientId="412" GUID="503990ee-2dee-d4fe-5f05-29a09780a239" backupsetName="defaultBackupSet" entityId="37" />
</vApp>
</Api_GetVirtualAppResp>
Last modified: 1/10/2018 5:21:15 PM