Get Recovery Status

GET https://{{cluster_vip}}/v2/data-protect/recoveries/{{restoreId}}

Returns the status of the recovery task.

You can fetch the restore ID (restoreId) to be specified in the API URL from the Recover VMware VMs API response.

RESPONSES

status: OK

"{\n    \"id\": \"8046495520451254:1678033142627:1414\",\n    \"name\": \"API_recover\",\n    \"startTimeUsecs\": 1678182755181347,\n    \"endTimeUsecs\": 1678183860335694,\n    \"status\": \"Succeeded\",\n    \"progressTaskId\": \"recover_1414\",\n    \"snapshotEnvironment\": \"kVMware\",\n    \"recoveryAction\": \"RecoverVMs\",\n    \"permissions\": [],\n    \"creationInfo\": {\n        \"userName\": \"{{username}}\"\n    },\n    \"canTearDown\": false,\n    \"messages\": null,\n    \"retrieveArchiveTasks\": null,\n    \"isMultiStageRestore\": false,\n    \"vmwareParams\": {\n        \"objects\": [\n            {\n                \"snapshotId\": \"{{snapshotId}}\",\n                \"protectionGroupId\": \"8046495520451254:1678033142627:123\",\n                \"protectionGroupName\": \"UI_Auto_VM_backup_Job\",\n                \"snapshotCreationTimeUsecs\": 1678170183596405,\n                \"snapshotTargetType\": \"Local\",\n                \"storageDomainId\": 31,\n                \"progressTaskId\": \"recover_1414/restore_object_0\",\n                \"status\": \"Succeeded\",\n                \"startTimeUsecs\": 1678182755000000,\n                \"endTimeUsecs\": 1678183849000000,\n                \"messages\": null,\n                \"objectInfo\": {\n                    \"id\": 3328,\n                    \"name\": \"{{VM_name}}\",\n                    \"sourceId\": 1,\n                    \"sourceName\": \"{{vCenter_name}}\",\n                    \"environment\": \"kVMware\",\n                    \"objectType\": \"kVirtualMachine\",\n                    \"uuid\": \"{{uuid}}\",\n                    \"osType\": \"kLinux\"\n                },\n                \"datastoreMigrationInfo\": {\n                    \"progressTaskId\": \"recover_1414/restore_object_0/storage_vmotion\",\n                    \"status\": \"Succeeded\",\n                    \"startTimeUsecs\": 1678182755000000,\n                    \"endTimeUsecs\": 1678183849000000\n                },\n                \"instantRecoveryInfo\": {\n                    \"progressTaskId\": \"recover_1414/restore_object_0/create_vm\",\n                    \"status\": \"Succeeded\",\n                    \"startTimeUsecs\": 1678182755000000,\n                    \"endTimeUsecs\": 1678182767000000\n                },\n                \"childSnapshots\": null\n            }\n        ],\n        \"recoveryAction\": \"RecoverVMs\",\n        \"recoverVmParams\": {\n            \"recoverProtectionGroupRunsParams\": null,\n            \"targetEnvironment\": \"kVMware\",\n            \"vmwareTargetParams\": {\n                \"powerOnVms\": true,\n                \"continueOnError\": false,\n                \"recoveryProcessType\": \"InstantRecovery\",\n                \"isMultiStageRestore\": false,\n                \"recoveryTargetConfig\": {\n                    \"recoverToNewSource\": true,\n                    \"newSourceConfig\": {\n                        \"sourceType\": \"kVCenter\",\n                        \"vCenterParams\": {\n                            \"datastores\": [\n                                {\n                                    \"id\": {{datastoresId}},\n                                    \"name\": \"ISO\"\n                                }\n                            ],\n                            \"networkConfig\": {\n                                \"detachNetwork\": true,\n                                \"newNetworkConfig\": {}\n                            },\n                            \"resourcePool\": {\n                                \"id\": {{resourcePoolId}},\n                                \"name\": \"Resources\"\n                            },\n                            \"source\": {\n                                \"id\": 1,\n                                \"name\": \"{{Target_vCenter_name}}\"\n                            },\n                            \"vmFolder\": {\n                                \"id\": {{vmFolderId}},\n                                \"name\": \"vm_folder-c4da-279764678\"\n                            }\n                        }\n                    }\n                },\n                \"renameRecoveredVmsParams\": {\n                    \"prefix\": \"copy-\"\n                }\n            }\n        }\n    }\n}"