This operation returns a list of recovery points for an Exchange DAG client.
Request
Syntax
GET <webservice>/Exchange/DAG/{clientId}/RecoveryPoints?instanceId={instanceId}&backupsetId={backupsetId}&subclientId={subclientId}&appId={appId} 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 |
---|---|---|
clientId |
The client ID for the client. If the client ID is not known, use the GET Client API to retrieve it. |
Yes |
instanceId |
The instance ID for the instance. If the instance ID is not known, use the GET Backup Set API to retrieve it. |
No-use 0 as the value if you are not sending an ID. |
backupsetId |
The backup set ID for the backup set. If the backup set ID is not known, use the GET Backup Set API to retrieve it. |
No-use 0 as the value if you are not sending an ID. |
subclientId |
The subclient ID for the subclient. If the subclient ID is not known, use the GET Subclient API to retrieve it. |
No-use 0 as the value if you are not sending an ID. |
appId |
The application type ID for the agent type associated with the file. The valid value is 53. |
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 |
---|---|---|
id |
The system-generated Id assigned to the recovery point. |
rpObjectList |
searchKey |
rpObjectList |
|
srcClientId |
The system-generated ID assigned to the client. |
rpObjectList |
srcInstanceId |
The system-generated ID assigned to the instance. |
rpObjectList |
srcBkpSetId |
The system-generated ID assigned to the backup set. |
rpObjectList |
srcSubclientId |
The system-generated ID assigned to the subclient. |
rpObjectList |
mountHostId |
The system-generated ID assigned to the MediaAgent that was selected for message recovery. |
rpObjectList |
bkpJobId |
The system-generated ID assigned to the backup job. |
rpObjectList |
recoveryTime |
The date and time that the backup job was run (backup job reference time). Valid values are UNIX-style timestamps (seconds since January 1, 1970). |
rpObjectList |
rpJobId |
The system-generated ID assigned to the recovery point job. |
rpObjectList |
srcPath |
The name of the Exchange database. |
rpObjectList |
mountPath |
The path on the MediaAgent where the mount point is created. |
rpObjectList |
phase |
Valid values are:
|
rpObjectList |
appType |
The ID of the application (agent). The ID for the Exchange database agent is 53. |
rpObjectList |
bkpType |
Valid values are:
|
rpObjectList |
appData |
rpObjectList |
|
expireTime |
The date that the recovery point expires. Valid values are UNIX-style timestamps (seconds since January 1, 1970). |
rpObjectList |
userName |
rpObjectList |
|
initRequest |
rpObjectList |
|
createTime |
The date when the recovery point was created. Valid values are UNIX-style timestamps (seconds since January 1, 1970). |
rpObjectList |
mountHostName |
The name of the MediaAgent that was selected for message recovery. |
rpObjectList |
Examples
Sample Request
GET <webservice>/Exchange/DAG/1079/RecoveryPoints?instanceId=0&backupsetId=0&subclientId=0&appId=53
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Sample Response
XML
<?xml version='1.0' encoding='utf-8' ?>
<Ida_GetLiveBrowseRecoveryPointsResp> <rpObjectList id="22" searchKey="127745edb" srcClientId="1079" srcInstanceId="0" srcBkpSetId="3397" srcSubclientId="6674" mountHostId="1080" bkpJobId="127745" recoveryTime="1520240456" rpJobId="130263" srcPath="edb" mountPath="<\\PRPROXY2010\sc_6674_job_128005\1520936847\Microsoft Information Store\edb\EDBFILES\edb.EDB>" phase="3" appType="53" bkpType="3" appData="" expireTime="1521023246" userName="" initRequest="<databrowse_BrowseRequest opType="0"><processinginstructioninfo><user _type_="13" userId="1" userName="admin"/><locale _type_="66" localeId="0"/><formatFlags continueOnError="0" elementBased="0" filterUnInitializedFields="0" formatted="0" ignoreUnknownTags="1" skipIdToNameConversion="1" skipNameToIdConversion="0"/></processinginstructioninfo><session sessionId="15120-1520936729422-1"/><entity backupsetId="3397" clientId="1079" commCellId="0" subclientId="6674"/><paths path="edb"/><timeRange fromTime="0" toTime="1520240456"/><ma clientId="1080"/><advOptions copyPrecedence="0"><advConfig><applicationMining appType="53" isApplicationMiningReq="1"><connectionInfo connectBackHost="fastidaR2.idcprodcert.loc*fastidar2*8400*8402" connectBackService="BrowseRouter" workerId="85"/><browseInitReq appMinType="2" bCreateRecoveryPoint="1" expireDays="1"><miningJobs val="126945"/><miningJobs val="127029"/><miningJobs val="127078"/><miningJobs val="127117"/><miningJobs val="127173"/><miningJobs val="127214"/><miningJobs val="127271"/><miningJobs val="127313"/><miningJobs val="127355"/><miningJobs val="127410"/><miningJobs val="127455"/><miningJobs val="127500"/><miningJobs val="127543"/><miningJobs val="127605"/><miningJobs val="127649"/><miningJobs val="127692"/><miningJobs val="127786"/><miningJobs val="127861"/><miningJobs val="127916"/><miningJobs val="127959"/><miningJobs val="128005"/><miningJobs val="127745"/></browseInitReq></applicationMining></advConfig></advOptions><queries><dataParam><paging pageSize="300"/></dataParam></queries></databrowse_BrowseRequest>" createTime="1520936854"> <mountHostName>prproxy2010</mountHostName> </rpObjectList> <rpObjectList id="23" searchKey="127745perfdb" srcClientId="1079" srcInstanceId="0" srcBkpSetId="3397" srcSubclientId="6674" mountHostId="1080" bkpJobId="127745" recoveryTime="1520240456" rpJobId="130265" srcPath="perfdb" mountPath="<\\PRPROXY2010\sc_6674_job_128005\1520936847\Microsoft Information Store\perfdb\EDBFILES\perfdb.edb>" phase="3" appType="53" bkpType="3" appData="" expireTime="1521023316" userName="" initRequest="<databrowse_BrowseRequest opType="0"><processinginstructioninfo><user _type_="13" userId="1" userName="admin"/><locale _type_="66" localeId="0"/><formatFlags continueOnError="0" elementBased="0" filterUnInitializedFields="0" formatted="0" ignoreUnknownTags="1" skipIdToNameConversion="1" skipNameToIdConversion="0"/></processinginstructioninfo><session sessionId="15268-1520936802073-1"/><entity backupsetId="3397" clientId="1079" commCellId="0" subclientId="6674"/><paths path="perfdb"/><timeRange fromTime="0" toTime="1520240456"/><ma clientId="1080"/><advOptions copyPrecedence="0"><advConfig><applicationMining appType="53" isApplicationMiningReq="1"><connectionInfo connectBackHost="fastidaR2.idcprodcert.loc*fastidar2*8400*8402" connectBackService="BrowseRouter" workerId="92"/><browseInitReq appMinType="2" bCreateRecoveryPoint="1" expireDays="1"><miningJobs val="126945"/><miningJobs val="127029"/><miningJobs val="127078"/><miningJobs val="127117"/><miningJobs val="127173"/><miningJobs val="127214"/><miningJobs val="127271"/><miningJobs val="127313"/><miningJobs val="127355"/><miningJobs val="127410"/><miningJobs val="127455"/><miningJobs val="127500"/><miningJobs val="127543"/><miningJobs val="127605"/><miningJobs val="127649"/><miningJobs val="127692"/><miningJobs val="127786"/><miningJobs val="127861"/><miningJobs val="127916"/><miningJobs val="127959"/><miningJobs val="128005"/><miningJobs val="127745"/></browseInitReq></applicationMining></advConfig></advOptions><queries><dataParam><paging pageSize="300"/></dataParam></queries></databrowse_BrowseRequest>" createTime="1520936921"> <mountHostName>prproxy2010</mountHostName> </rpObjectList>
</Ida_GetLiveBrowseRecoveryPointsResp>
JSON
{ { "rpObjectList": [{ "phase": 3, "recoveryTime": 1520240456, "bkpJobId": 127745, "mountPath": "\\\\PRPROXY2010\\sc_6674_job_128005\\1520936847\\Microsoft Information Store\\edb\\EDBFILES\\edb.EDB", "initRequest": "<databrowse_BrowseRequest opType=\"0\"><processinginstructioninfo><user _type_=\"13\" userId=\"1\" userName=\"admin\"/><locale _type_=\"66\" localeId=\"0\"/><formatFlags continueOnError=\"0\" elementBased=\"0\" filterUnInitializedFields=\"0\" formatted=\"0\" ignoreUnknownTags=\"1\" skipIdToNameConversion=\"1\" skipNameToIdConversion=\"0\"/></processinginstructioninfo><session sessionId=\"15120-1520936729422-1\"/><entity backupsetId=\"3397\" clientId=\"1079\" commCellId=\"0\" subclientId=\"6674\"/><paths path=\"edb\"/><timeRange fromTime=\"0\" toTime=\"1520240456\"/><ma clientId=\"1080\"/><advOptions copyPrecedence=\"0\"><advConfig><applicationMining appType=\"53\" isApplicationMiningReq=\"1\"><connectionInfo connectBackHost=\"fastidaR2.idcprodcert.loc*fastidar2*8400*8402\" connectBackService=\"BrowseRouter\" workerId=\"85\"/><browseInitReq appMinType=\"2\" bCreateRecoveryPoint=\"1\" expireDays=\"1\"><miningJobs val=\"126945\"/><miningJobs val=\"127029\"/><miningJobs val=\"127078\"/><miningJobs val=\"127117\"/><miningJobs val=\"127173\"/><miningJobs val=\"127214\"/><miningJobs val=\"127271\"/><miningJobs val=\"127313\"/><miningJobs val=\"127355\"/><miningJobs val=\"127410\"/><miningJobs val=\"127455\"/><miningJobs val=\"127500\"/><miningJobs val=\"127543\"/><miningJobs val=\"127605\"/><miningJobs val=\"127649\"/><miningJobs val=\"127692\"/><miningJobs val=\"127786\"/><miningJobs val=\"127861\"/><miningJobs val=\"127916\"/><miningJobs val=\"127959\"/><miningJobs val=\"128005\"/><miningJobs val=\"127745\"/></browseInitReq></applicationMining></advConfig></advOptions><queries><dataParam><paging pageSize=\"300\"/></dataParam></queries></databrowse_BrowseRequest>", "srcPath": "edb", "srcInstanceId": 0, "bkpType": 3, "searchKey": "127745edb", "userName": "", "srcClientId": 1079, "appData": "", "rpJobId": 130263, "expireTime": 1521023246, "srcBkpSetId": 3397, "createTime": 1520936854, "appType": 53, "mountHostName": "prproxy2010", "srcSubclientId": 6674, "id": 22, "mountHostId": 1080 }, { "phase": 3, "recoveryTime": 1520240456, "bkpJobId": 127745, "mountPath": "\\\\PRPROXY2010\\sc_6674_job_128005\\1520936847\\Microsoft Information Store\\perfdb\\EDBFILES\\perfdb.edb", "initRequest": "<databrowse_BrowseRequest opType=\"0\"><processinginstructioninfo><user _type_=\"13\" userId=\"1\" userName=\"admin\"/><locale _type_=\"66\" localeId=\"0\"/><formatFlags continueOnError=\"0\" elementBased=\"0\" filterUnInitializedFields=\"0\" formatted=\"0\" ignoreUnknownTags=\"1\" skipIdToNameConversion=\"1\" skipNameToIdConversion=\"0\"/></processinginstructioninfo><session sessionId=\"15268-1520936802073-1\"/><entity backupsetId=\"3397\" clientId=\"1079\" commCellId=\"0\" subclientId=\"6674\"/><paths path=\"perfdb\"/><timeRange fromTime=\"0\" toTime=\"1520240456\"/><ma clientId=\"1080\"/><advOptions copyPrecedence=\"0\"><advConfig><applicationMining appType=\"53\" isApplicationMiningReq=\"1\"><connectionInfo connectBackHost=\"fastidaR2.idcprodcert.loc*fastidar2*8400*8402\" connectBackService=\"BrowseRouter\" workerId=\"92\"/><browseInitReq appMinType=\"2\" bCreateRecoveryPoint=\"1\" expireDays=\"1\"><miningJobs val=\"126945\"/><miningJobs val=\"127029\"/><miningJobs val=\"127078\"/><miningJobs val=\"127117\"/><miningJobs val=\"127173\"/><miningJobs val=\"127214\"/><miningJobs val=\"127271\"/><miningJobs val=\"127313\"/><miningJobs val=\"127355\"/><miningJobs val=\"127410\"/><miningJobs val=\"127455\"/><miningJobs val=\"127500\"/><miningJobs val=\"127543\"/><miningJobs val=\"127605\"/><miningJobs val=\"127649\"/><miningJobs val=\"127692\"/><miningJobs val=\"127786\"/><miningJobs val=\"127861\"/><miningJobs val=\"127916\"/><miningJobs val=\"127959\"/><miningJobs val=\"128005\"/><miningJobs val=\"127745\"/></browseInitReq></applicationMining></advConfig></advOptions><queries><dataParam><paging pageSize=\"300\"/></dataParam></queries></databrowse_BrowseRequest>", "srcPath": "perfdb", "srcInstanceId": 0, "bkpType": 3, "searchKey": "127745perfdb", "userName": "", "srcClientId": 1079, "appData": "", "rpJobId": 130265, "expireTime": 1521023316, "srcBkpSetId": 3397, "createTime": 1520936921, "appType": 53, "mountHostName": "prproxy2010", "srcSubclientId": 6674, "id": 23, "mountHostId": 1080 }] }