Oracle Restore Options
Select
This operation is used to perform Oracle Restores
- application/json
Request Body
taskInfo object
task object
taskType requiredPossible values: [
IMMEDIATE
,SCHEDULE
,SCHEDULE_POLICY
,SAVED_REPORT
]associations object[]
clientName string requiredSource Client Name
displayName stringClient display Name
instanceName string requiredSource Instance Name
appName stringOracle
subTasks object[]
subTask object
subTaskType stringRESTORE
operationType stringRESTORE
options object
restoreOptions object
browseOption object
commCellId integerDefault value:
2
mediaOption object
mediaAgent object
Select specific mediaagent for restore job
mediaAgentId integerMedia Agent ID
timeRange object
Browse time range
toTime integerdestination object
destClient object required
Client details for restore
clientName string requiredClient Name of destination client
displayName stringDisplay Name of destination client
destinationInstance object required
instanceName stringDestination Instance Name
appName stringDefault value:
Oracle
clientName stringDestination client Name
displayName stringDestination display name.
destPath string[]The destination path for restore to disk
oracleOpt object
restoreControlFile booleanEnable this option if you want the control file to be restored
restoreSPFile booleanEnable this option to restore SP file.
restoreData booleanEnable this option to restore datafiles
restoreFromPossible values: [
0 - Current Time
,1 - Point in Time
,2 - SCN
,3 - Most Recent Backup
]Select database state to be restored from given options Default - Point in Time
recover booleanEnable this option to run recovery
recoverFromPossible values: [
0 - Current Time
,1 - Point in Time
,2 - SCN
,3 - Most Recent Backup
]Select database state to be recovered to from given options
recoverSCN integerThe SCN to recover the database to.
ctrlBackupPiece stringName of the control backup piece
specifyControlFileTime booleanEnable this option for Point-in-time restores
ControlFileTime object
Relevant for point-in-time restores
time integerSpecify the point in time to restore controlfile from
recoverTime object
Relevant for PIT restores
time integerSpecify the point in time to recover the database to
restoreTime object
Relevant for point in time restores
time integerPoint in Time to restore files
noCatalog booleanSet to false if recovery catalog is configured
restoreStream integerDefault value:
2
Number of restore streams
resetLogs integerDefault value:
1
Set to 1 to resetlogs
duplicateToLogFilesList stringList of redo log volumes to be created
duplicateToLogFile booleanSet to true to create redo logs
redirectItemsPresent booleanSet to true if some datafiles being restored need to be redirected
duplicateToLogFilesListValue string[]List of redo log files to be created
redirectItems string[]List of files are to be redirected
logFileGroup booleanSet to true to redirect redo logs
redirectItemsValue string[]List of redirect file paths
redirectAllItemsSelected booleanSet to true if you want to redirect all datafiles to a single path
renamePathForAllTablespaces stringPath to Redirect all datafiles / Redirect all PDBs for PDB Clone
switchDatabaseMode booleanSet to true to switch initital mode of destination database to appropriate mode for restore
redirectTempFilesSelected booleanSet to true to redirect temp datafiles
redirectTempFilesValue stringPath to which redirect temp file must be redirected
restoreWallet booleanSet to true to restore Oracle wallet for cross machine restores
crossmachineRestoreOptions object
Relevant for cross machine restores
doNidForCrossMachineRestore booleanDefault value:
true
setDBId booleanDefault value:
true
Set to true for Crossmachine Restores
duplicateNoFileNamecheck booleanSet to true for cross machine restores
archiveLog booleanSet to true to restore archivelogs
logTarget stringDirectory where the archivelogs are to be restored
archivelLogByPossible values: [
DEFAULT
,BYLSN
,BYTIME
]Select parameter to restore archivelogs
logTime object
Set logTime if archiveLogBy is set to BYTIME
fromTime integerStart Time for picking archivelogs
toTime integerFrom time for archive logs
useStartLog booleanEnable useStartLog if you want to filter archivelogs by a start time
useEndLog booleanEnable useEndLog if you want to filter archivelogs by a end time
useStartLSNNum booleanEnable to filter archivelogs by start SCN
startLSNNum integerEnter start SCN to select archive logs
useEndLSNNum booleanEnable to filter archivelogs by End SCN
endLSNNum integerEnter End SCN to select archive logs
duplicate booleanSet to true for RMAN duplicate
duplicateStandby booleanSet to true to create standby database
duplicateTo booleanSet to true for duplicateTo
duplicateToName stringName of destination instance to duplicate to.
duplicateStandbySID stringDefault value:
dup
duplicateStandbyDoRecover booleanDefault value:
false
partialRestore booleanSet to true for database partial restores
stagingPath stringEnter staging path for Partial database restore job/ Table level restore job/ PDB Clone
cleanupAuxiliary booleanSet to true to cleanup auxiliary
sourcePaths string[]Source Paths for oracle table restore / PDB Clone
auxiliaryInstance booleanSet to true for user created auxiliary for table level restores
databaseName stringName of user-created auxiliary instance
importToWherePossible values: [
IMPORT_TO_SOURCE
,IMPORT_TO_ANOTHER
,DO_NOT_IMPORT
]Select relevant option to import tables to source database/a different database/create dumps only
importDatabase stringEnter destination database name if IMPORT_TO_ANOTHER is selected
dropTable booleanSet to true to drop table if it exists at the destination
tableViewRestore booleanSet to true for table level restore
oracleTableRstOptions object
Oracle table level restore options
includeTriggers booleanDefault value:
true
includeConstraints booleanDefault value:
true
includeIndexes booleanDefault value:
true
includeGrants booleanDefault value:
true
includeStoredProcedures booleanDefault value:
true
importDbClient object
This section is relevant only for table restores
clientId stringClientId of destination client to import tables
clientName stringClient name of destination client to import tables
displayName stringDisplay name of destination client to import tables
oracleObjectRenameInfoList object[]PDB Clone Options
filename stringSet to the staging path for pdb clone
commonOptions object
indexFreeRestore booleanSet to true for restore to disk
restoreToDisk booleanSet to true for Restore to disk
openDatabase booleanSet to true to open the database post restore, applicable for pdbs too
fileOption object
sourceItem string[]Files to be restored. Set it to the database SID for full database restore.
commonOpts object
notifyUserOnJobCompletion booleanDefault value:
true
- 200
- 400
- 401
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- taskId integer
- jobIds string[]
{
"taskId": 0,
"jobIds": [
"string"
]
}
{
"taskId": 1939,
"jobIds": [
"29408"
]
}
Bad Request
- application/json
- Schema
- Example
Schema
- string
Request body is empty or format is invalid
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Access Denied",
"errorCode": 5
}