MySQL Restore Operations
Select
This operation is used to run MySQL restores
- application/json
Request Body
taskInfo object
task object
taskType requiredPossible values: [
IMMEDIATE
,SCHEDULE
]associations object[]
displayName stringClient display name
clientId integerinstanceName string requiredSource MySQL Instance name
appName string requiredDefault value:
MySQL
Application name
applicationId integerDefault value:
104
104 for MySQL
clientName string requiredSource MySQL Client name
backupsetName string requiredDefault value:
defaultDummyBackupSet
Backupset Name
subclientName stringDatabase group name if the restore is initiated from database group level
subclientId stringDatabase group ID when restore to be initiated from database group level
subTasks object[]
subTask object
subTaskType string requiredDefault value:
RESTORE
operationType string requiredDefault value:
RESTORE
options object
restoreOptions object
browseOption object
commCellId integerbackupset object
backupsetId integerclientId integernoImage booleanuseExactIndex booleanmediaOption object
copyPrecedence object
copyPrecedenceApplicable booleanlistMedia booleantimeRange object
fromTime integerFrom time in epoch
toTime integerTo time in epoch
destination object
destClient object
clientName string requiredDestination Client Name
clientId integerDestination Client ID
destinationInstance object
clientName string requiredDestination Client Name
instanceName string requiredDestinaton MySQL Instance name
displayName stringDestination client display name
instanceId integerDestination MySQL instance ID
clientId integerDestination client ID
appName string requiredDefault value:
MySQL
applicationId integerDefault value:
104
mySqlRstOption object
MySQL Restore options
pointofTime booleanIs the restore Point in Time
fromTime object
time integerrefTime object
time integerdestinationServer object required
name string requiredDestination MySQL Instance name
id integerDestination MySQL Instance ID
pointInTime object
time integerinstanceRestore booleandata booleanFlag for data only restore
log booleanFlag for Log only restore
recurringRestore booleanlogRestoreTypePossible values: [
RECOVER
,DO_NOT_RECOVER
]Restore type
temporaryStagingLocation stringDefault value:
/opt/commvault/iDataAgent/jobResults
Staging location
destinationFolder stringDefault value:
/opt/commvault/iDataAgent/jobResults
Destination Folder for Restore to Disk
tableLevelRestore booleanTable level restore supported with MySQL Block Level backups
isCloneRestore booleanInstant Clone restore
cloneOptions object
isInstanceSelected booleanSource MySQL Instance id for fetching MySQL binary directory
binaryDirectory stringBinary directory of Source MySQL Instance
user stringport stringPort number for Clone MySQL Server
stagingLocaion stringreservationPeriodS integerReserve Clone for time (in seconds)
forceCleanup booleanClone clean up after reserved time
fileOption object
sourceItem string[]Databases list to be restored
commonOpts object
prePostOpts object
postRecoveryCommand stringPost recovery commnad after clone operation
impersonation object
Impersonate user for Clone Operation
level stringDefault value:
USR_LOCAL_SYS_ADMIN
notifyUserOnJobCompletion boolean
- 200
- 400
- 401
- 403
- 500
OK
Response Headers
- application/json
- Schema
- Example (from schema)
- Example
Schema
- taskId integer
- jobIds string[]
JobId of install job triggered
{
"taskId": 0,
"jobIds": [
"string"
]
}
{
"taskId": 2176,
"jobIds": [
"35886"
]
}
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
}
Forbidden
- application/json
- Schema
- Example (from schema)
- Example
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "User [Remote User] does not have required capability [In Place Recover] for this subclient and this operation.",
"errorCode": 587204041
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Failed to start backups as no eligible subclients were found. ",
"errorCode": 587207178
}