Azure MySQL instance restore
Select
This operation is used to submit Azure MYSQL instance restores.
- application/json
Request Body
taskInfo object
associations object[]
clientName string requiredName of the cloud account
instanceName string requiredName of the instance
displayName stringDisplay name of the cloud account
_type_ string requiredPossible values: [
INSTANCE_ENTITY
,BACKUPSET_ENTITY
,SUBCLIENT_ENTITY
]backupsetName string requiredDefault value:
defaultDummyBackupSet
applicationId integer requiredDefault value:
104
subclientName stringDatabase group name if the restore is initiated from database group level
task object
taskType string requiredPossible values: [
IMMEDIATE
,SCHEDULE
]subTasks object[]
subTask object
subTaskType stringDefault value:
RESTORE
operationType stringDefault value:
RESTORE
options object
restoreOptions object
browseOption object
commCellId integertimeRange object
fromTime integertoTime integerbackupset object required
clientName stringbackupsetName stringdestination object
destClient object
clientName string requiredDestination Client Name
destinationInstance object
clientName string requiredDestination Client Name
instanceName string requiredDestinaton Instance name
displayName stringDestination Client Display Name
applicationId integer requiredDefault value:
104
fileOption object required
sourceItem string[]List of databases to restore
mySqlRstOption object
pointofTime booleanTrue if point in time restore
refTime object
time integerfromTime object
time integerpointInTime object
time integerdestinationServer object
name string requiredDestination Instance name
data boolean requiredDefault value:
true
destinationFolder stringDestination folder location if Restore to disk
pointOfTime booleanTrue if point in time restore
commonOpts object
notifyUserOnJobCompletion booleanDefault value:
true
prePostOpts object
preRecoveryCommand stringpostRecoveryCommand stringrunPostWhenFail boolean
- 200
- 400
- 500
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- taskId integer
- jobIds string[]
{
"taskId": 0,
"jobIds": [
"string"
]
}
{
"taskId": 9957,
"jobIds": [
"110838"
]
}
Bad Request
- application/json
- Schema
- Example 1
Schema
- string
Request body is empty or format is invalid
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
}