This operation returns the properties associated with the entities in the Disaster Recovery (DR) group.
Request
Syntax
GET <webservice>/DRGroups/ClientList?source={source}&entityType={entityType}&entityId={entityId} 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 Parameters
Name | Description | Required |
source | Valid values are:
| Yes |
entityType | The option to return the properties of a client or client group. Use the entityId parameter to define the specific client or client group. Valid values are:
| Yes |
entityId | The ID of the client or client group. The entityType parameter determines whether a client or client group is returned. If the entity ID is not known, use the GET Client or GET Client Group to retrieve it. | Yes |
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 |
source | Valid values are:
| Ida_ClientListForVAppResp |
scheduleName | Name of the schedule. | client |
copyPrecedence | The copy that takes precedence for failover. Valid values are 0/1. | client |
destVendor | The destination vendor to which the machine has been replicated. Valid values:
| client |
failoverStatus | The failoverstatus of the virtual machine. | client |
replcationId | The ID for the replication set. | client |
isVM | Valid values are 0/1. | client |
vendor | Valid values are:
| client |
syncStatus | The status of the sync. | client |
_type_ | The type of entity. Valid value is 55, for time zone. | lastbackuptime |
time | Time of the last backup. | lastbackuptime |
backupsetId | The ID for the backupset. | backupSet |
backupsetName | The name of the backupset. | backupSet |
applicationId | The ID of the application. | backupSet |
clientName | The name of the hypervisor client that the machine is replicated to | destinationClient |
clientId | The ID of the destination client. | destinationClient |
_type_ | The type of entity. Valid value is 3, for client. | destinationClient |
clientName | The name of the replication machine. | destClient |
GUID | The globally unique identifier for the destination client. | destClient |
_type_ | The type of entity. Valid value is 3, for client. | destClient |
subclientId | The ID of the subclient. | client |
clientName | The name of the client. | client |
instanceId | The system-generated ID assigned to the instance. | client |
clientId | The system-generated ID assigned to the client. | client |
GUID | The globally unique identifier for the virtualization client. | client |
_type_ | The type of entity. Valid value is 3, for client. | client |
Examples
Sample Request
GET <webservice>/DRGroups/ClientList?source=1&entityType=3&entityId=385 HTTP/1.1
Host: client.mydomain.com
Accept:application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8Sample Response
JSON
{
"source": 1,
"client": [{
"scheduleName": "TestingDataDirects",
"copyPrecedence": 0,
"destVendor": 1,
"failoverStatus": 1,
"supportedOperation": 1,
"replicationId": 8,
"isVM": true,
"vendor": 1,
"syncStatus": 6,
"lastbackuptime": {
"_type_": 55,
"time": 1501359259
},
"lastSyncTime": {
"_type_": 55,
"time": 1501358851
},
"backupSet": {
"backupsetId": 39,
"backupsetName": "TestDataReDirects",
"applicationId": 0
},
"destinationClient": {
"clientName": "test.company.com",
"clientId": 7,
"_type_": 3
},
"destClient": {
"clientName": "vlab12_Dest",
"GUID": "5039edf8-ed64-5b9e-4f88-378d9a76ab67",
"_type_": 3
},
"client": {
"subclientId": 66,
"clientName": "vlab12",
"instanceId": 4,
"clientId": 14,
"GUID": "50397438-4cd0-885d-971b-7c9af35173d0",
"_type_": 3
}
}, {
"scheduleName": "TestingDataDirects",
"copyPrecedence": 0,
"destVendor": 1,
"failoverStatus": 8,
"supportedOperation": 1,
"replicationId": 7,
"isVM": true,
"vendor": 1,
"syncStatus": 4,
"lastbackuptime": {
"_type_": 55,
"time": 1502155050
},
"lastSyncTime": {
"_type_": 55,
"time": 1501358196
},
"backupSet": {
"backupsetId": 39,
"backupsetName": "TestDataReDirects",
"applicationId": 0
},
"destinationClient": {
"clientName": "test.company.com",
"clientId": 7,
"_type_": 3
},
"destClient": {
"clientName": "vlab14_Dest",
"GUID": "5039aa3c-79f4-a698-6f65-5d0766217adb",
"_type_": 3
},
"client": {
"subclientId": 66,
"clientName": "vlab14",
"instanceId": 4,
"clientId": 15,
"GUID": "5039740b-78ca-fee2-151e-1917e1aabc39",
"_type_": 3
}
}, {
"scheduleName": "TestingDataDirects",
"copyPrecedence": 0,
"destVendor": 1,
"failoverStatus": 0,
"replicationId": 9,
"isVM": true,
"vendor": 1,
"syncStatus": 1,
"lastbackuptime": {
"_type_": 55,
"time": 1501359259
},
"lastSyncTime": {
"_type_": 55,
"time": 1501358748
},
"backupSet": {
"backupsetId": 39,
"backupsetName": "TestDataReDirects",
"applicationId": 0
},
"destinationClient": {
"clientName": "test.company.com",
"clientId": 7,
"_type_": 3
},
"destClient": {
"clientName": "vlab15_Dest",
"GUID": "50396177-9660-2a29-90cc-448056909414",
"_type_": 3
},
"client": {
"subclientId": 66,
"clientName": "vlab15",
"instanceId": 4,
"clientId": 18,
"GUID": "5039de93-3a9a-0a5a-eafa-069647339feb",
"_type_": 3
}
}]
}
XML
<Ida_ClientListForVAppResp source="1">
<client scheduleName="TestingDataDirects" copyPrecedence="0" destVendor="1" failoverStatus="1" supportedOperation="1" replicationId="8" isVM="1" vendor="1" syncStatus="6">
<lastbackuptime _type_="55" time="1501359259" />
<lastSyncTime _type_="55" time="1501358851" />
<backupSet backupsetId="39" backupsetName="TestDataReDirects" applicationId="0" />
<destinationClient clientName="test.company.com" clientId="7" _type_="3" />
<destClient clientName="vlab12_Dest" GUID="5039edf8-ed64-5b9e-4f88-378d9a76ab67" _type_="3" />
<client subclientId="66" clientName="vlab12" instanceId="4" clientId="14" GUID="50397438-4cd0-885d-971b-7c9af35173d0" _type_="3" />
</client>
<client scheduleName="TestingDataDirects" copyPrecedence="0" destVendor="1"
failoverStatus="8" replicationId="7" isVM="1" vendor="1" syncStatus="4">
<lastbackuptime _type_="55" time="1502155050" />
<lastSyncTime _type_="55" time="1501358196" />
<backupSet backupsetId="39" backupsetName="TestDataReDirects" applicationId="0" />
<destinationClient clientName="test.company.com" clientId="7" _type_="3" />
<destClient clientName="vlab14_Dest" GUID="5039aa3c-79f4-a698-6f65-5d0766217adb" _type_="3" />
<client subclientId="66" clientName="vlab14" instanceId="4" clientId="15" GUID="5039740b-78ca-fee2-151e-1917e1aabc39" _type_="3" />
</client>
<client scheduleName="TestingDataDirects" copyPrecedence="0" destVendor="1" failoverStatus="0" supportedOperation="1" replicationId="9" isVM="1" vendor="1" syncStatus="1">
<lastbackuptime _type_="55" time="1501359259" />
<lastSyncTime _type_="55" time="1501358748" />
<backupSet backupsetId="39" backupsetName="TestDataReDirects" applicationId="0" />
<destinationClient clientName="test.company.com" clientId="7" _type_="3" />
</client>
</Ida_ClientListForVAppResp>