name | data type | constraints | description |
---|---|---|---|
restorePath | string | max size: 511, min size: 0 | |
backup | NameAndGuid | ||
backupLocation | NameAndGuid | required | |
restoredPeName | string | max size: 64, min size: 0 | |
restoreProject | NameAndGuid | ||
restoreStoragePool | NameAndGuid | ||
overwrite | boolean | required | |
extract | boolean | required | |
node | NameAndGuid | ||
retryCount | number | required, min: 0 | |
filesToRestore | array of BackupFile |
Example
{ "restorePath" : "...", "backup" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "backupLocation" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "restoredPeName" : "...", "restoreProject" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "restoreStoragePool" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "overwrite" : true, "extract" : true, "node" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "retryCount" : 12345, "filesToRestore" : [ { "guid" : "...", "ver" : 12345, "backupTime" : 12345, "lastModifiedTime" : 12345, "size" : 12345, "effectiveBackupSize" : 12345, "effectiveSuccessfulObjects" : 12345, "effectiveTotalDirectories" : 12345, "effectiveFailedObjects" : 12345, "effectiveProcessedDirectories" : 12345, "effectiveSkippedObjects" : 12345, "path" : "...", "originalPath" : "...", "mountable" : true, "originalStorageId" : "...", "originalDiskId" : "...", "encryption" : 12345, "config" : "...", "objectName" : "...", "nameAndGuid" : { "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "sessionId" : "...", "cloudFeature" : "EXCHANGE_CALENDARS", "format" : "UNRECOGNIZED", "nameGuidAndType" : { "type" : { }, "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67", "name" : "Entity name" }, "underlyingStorageType" : "GCE_PD", "compressionType" : "DISABLED", "backup" : { "guid" : "...", "ver" : 12345, "nameAndGuid" : { }, "nameGuidAndType" : { }, "snapshotTime" : 12345, "backupTime" : 12345, "archiveExpire" : 12345, "size" : 12345, "fileCount" : 12345, "effectiveBackupObjectsCount" : 12345, "effectiveBackupSize" : 12345, "hidden" : true, "originEntityType" : "SCHEDULE", "originEntityName" : "...", "originEntityGuid" : "...", "description" : "...", "status" : "PARTIAL_SUCCESS", "statusInfo" : "...", "storedBytes" : 12345, "backupLocations" : [ { }, { } ], "protectedEntity" : { }, "node" : { }, "backupRule" : { }, "protectedEntityType" : "STORAGE", "type" : "FULL", "parentBackup" : { }, "tasks" : [ { }, { } ], "files" : [ { }, { } ], "archivedTasks" : [ { }, { } ], "vmExportImportMode" : "DISK_ATTACHMENT", "warningsPresent" : true, "warnings" : [ { }, { } ], "baseImage" : { }, "sourceProject" : { }, "retentionHint" : "TO_REMOVE", "archivedBackup" : { }, "taskDurationTime" : 12345, "auditEntityName" : "...", "primaryBackupDestination" : { }, "primaryLocation" : { }, "nonPrimaryLocations" : [ { }, { } ], "secondaryBackupDestinations" : [ { }, { } ], "allBackupDestinations" : [ { }, { } ], "networkInterfaceCards" : [ { }, { } ], "locationStatuses" : [ "IN_PROGRESS", "REMOVED" ], "overallStatus" : "INPROGRESS", "statusBasedOnBackupFileLocations" : "SUCCESS_REMOVED", "agentType" : true, "deletable" : true }, "parentBackupFile" : { }, "locations" : [ { "backupDestination" : { }, "backupFile" : { }, "guid" : "...", "status" : "PRESENT", "ver" : 12345, "roleType" : "ARCHIVE", "backupTime" : 12345, "lastModifiedTime" : 12345, "encryption" : 12345, "config" : "...", "compressionType" : "BZIP2", "path" : "...", "tapeChunks" : [ { }, { } ], "auditEntityName" : "...", "nameAndGuid" : { }, "nameGuidAndType" : { } }, { "backupDestination" : { }, "backupFile" : { }, "guid" : "...", "status" : "PRESENT", "ver" : 12345, "roleType" : "PRIMARY", "backupTime" : 12345, "lastModifiedTime" : 12345, "encryption" : 12345, "config" : "...", "compressionType" : "DISABLED", "path" : "...", "tapeChunks" : [ { }, { } ], "auditEntityName" : "...", "nameAndGuid" : { }, "nameGuidAndType" : { } } ], "lvmType" : true, "metadataFormat" : true, "diskFormat" : true, "restoresTime" : [ 12345, 12345 ], "vmDisk" : { "name" : "...", "uuid" : "...", "devicePath" : "...", "fullDevicePath" : "...", "guid" : "...", "ver" : 12345, "controllerId" : "...", "slot" : "...", "size" : 12345, "present" : true, "excludedFromBackup" : true, "bootable" : true, "image" : true, "volumeSource" : "...", "volumeType" : "...", "type" : "OPENSTACK_SWAP", "supported" : true, "snapshots" : [ { }, { } ], "virtualMachine" : { }, "originalStorage" : { }, "auditEntityName" : "...", "nameAndGuid" : { }, "nameGuidAndType" : { } }, "auditEntityName" : "..." }, { "guid" : "...", "ver" : 12345, "backupTime" : 12345, "lastModifiedTime" : 12345, "size" : 12345, "effectiveBackupSize" : 12345, "effectiveSuccessfulObjects" : 12345, "effectiveTotalDirectories" : 12345, "effectiveFailedObjects" : 12345, "effectiveProcessedDirectories" : 12345, "effectiveSkippedObjects" : 12345, "path" : "...", "originalPath" : "...", "mountable" : true, "originalStorageId" : "...", "originalDiskId" : "...", "encryption" : 12345, "config" : "...", "objectName" : "...", "nameAndGuid" : { "guid" : "...", "name" : "..." }, "sessionId" : "...", "cloudFeature" : "TEAMS_CHANNEL", "format" : "DISK_META_GCP_INC", "nameGuidAndType" : { "type" : { }, "guid" : "...", "name" : "..." }, "underlyingStorageType" : "LVM_THIN", "compressionType" : "LZMA", "backup" : { "guid" : "...", "ver" : 12345, "nameAndGuid" : { }, "nameGuidAndType" : { }, "snapshotTime" : 12345, "backupTime" : 12345, "archiveExpire" : 12345, "size" : 12345, "fileCount" : 12345, "effectiveBackupObjectsCount" : 12345, "effectiveBackupSize" : 12345, "hidden" : true, "originEntityType" : "SYSTEM_SCHEDULE", "originEntityName" : "...", "originEntityGuid" : "...", "description" : "...", "status" : "SUCCESS", "statusInfo" : "...", "storedBytes" : 12345, "backupLocations" : [ { }, { } ], "protectedEntity" : { }, "node" : { }, "backupRule" : { }, "protectedEntityType" : "CLOUD", "type" : "SYNTHETIC", "parentBackup" : { }, "tasks" : [ { }, { } ], "files" : [ { }, { } ], "archivedTasks" : [ { }, { } ], "vmExportImportMode" : "EXPORT_STORAGE_REPO", "warningsPresent" : true, "warnings" : [ { }, { } ], "baseImage" : { }, "sourceProject" : { }, "retentionHint" : "STANDARD_RETENTION", "archivedBackup" : { }, "taskDurationTime" : 12345, "auditEntityName" : "...", "primaryBackupDestination" : { }, "primaryLocation" : { }, "nonPrimaryLocations" : [ { }, { } ], "secondaryBackupDestinations" : [ { }, { } ], "allBackupDestinations" : [ { }, { } ], "networkInterfaceCards" : [ { }, { } ], "locationStatuses" : [ "IN_PROGRESS", "REMOVED" ], "overallStatus" : "SUCCESS_REMOVED", "statusBasedOnBackupFileLocations" : "INPROGRESS", "agentType" : true, "deletable" : true }, "parentBackupFile" : { }, "locations" : [ { "backupDestination" : { }, "backupFile" : { }, "guid" : "...", "status" : "PRESENT", "ver" : 12345, "roleType" : "SECONDARY", "backupTime" : 12345, "lastModifiedTime" : 12345, "encryption" : 12345, "config" : "...", "compressionType" : "TAR_BZIP2", "path" : "...", "tapeChunks" : [ { }, { } ], "auditEntityName" : "...", "nameAndGuid" : { }, "nameGuidAndType" : { } }, { "backupDestination" : { }, "backupFile" : { }, "guid" : "...", "status" : "TORECREATE", "ver" : 12345, "roleType" : "SECONDARY", "backupTime" : 12345, "lastModifiedTime" : 12345, "encryption" : 12345, "config" : "...", "compressionType" : "BZIP2", "path" : "...", "tapeChunks" : [ { }, { } ], "auditEntityName" : "...", "nameAndGuid" : { }, "nameGuidAndType" : { } } ], "lvmType" : true, "metadataFormat" : true, "diskFormat" : true, "restoresTime" : [ 12345, 12345 ], "vmDisk" : { "name" : "...", "uuid" : "...", "devicePath" : "...", "fullDevicePath" : "...", "guid" : "...", "ver" : 12345, "controllerId" : "...", "slot" : "...", "size" : 12345, "present" : true, "excludedFromBackup" : true, "bootable" : true, "image" : true, "volumeSource" : "...", "volumeType" : "...", "type" : "OPENSHIFT_LUN", "supported" : true, "snapshots" : [ { }, { } ], "virtualMachine" : { }, "originalStorage" : { }, "auditEntityName" : "...", "nameAndGuid" : { }, "nameGuidAndType" : { } }, "auditEntityName" : "..." } ] }