MySQL Restore Operations
Select
SaaS
Customer Managed
This operation is used to run MySQL restores
- application/json
Request Body
taskInfo object
Responses
- 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
}
POST /createtask
Authorization
type: apiKeyname: Authtokenin: header
Request
Request
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/createTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"taskInfo": {
"task": {},
"associations": [
{
"displayName": "string",
"clientId": 0,
"instanceName": "string",
"appName": "MySQL",
"applicationId": 104,
"clientName": "string",
"backupsetName": "defaultDummyBackupSet",
"subclientName": "string",
"subclientId": "string"
}
],
"subTasks": [
{
"subTask": {
"subTaskType": "RESTORE",
"operationType": "RESTORE"
},
"options": {
"restoreOptions": {
"browseOption": {
"commCellId": 0,
"backupset": {
"backupsetId": 0,
"clientId": 0
},
"noImage": true,
"useExactIndex": true,
"mediaOption": {
"copyPrecedence": {
"copyPrecedenceApplicable": true
}
},
"listMedia": true,
"timeRange": {
"fromTime": 0,
"toTime": 0
}
},
"destination": {
"destClient": {
"clientName": "string",
"clientId": 0
},
"destinationInstance": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"instanceId": 0,
"clientId": 0,
"appName": "MySQL",
"applicationId": 104
}
},
"mySqlRstOption": {
"pointofTime": true,
"fromTime": {
"time": 0
},
"refTime": {
"time": 0
},
"destinationServer": {
"name": "string",
"id": 0
},
"pointInTime": {
"time": 0
},
"instanceRestore": true,
"data": true,
"log": true,
"recurringRestore": true,
"temporaryStagingLocation": "/opt/commvault/iDataAgent/jobResults",
"destinationFolder": "/opt/commvault/iDataAgent/jobResults",
"tableLevelRestore": true,
"isCloneRestore": true,
"cloneOptions": {
"isInstanceSelected": true,
"binaryDirectory": "string",
"user": "string",
"port": "string",
"stagingLocaion": "string",
"reservationPeriodS": 0,
"forceCleanup": true
},
"fileOption": {
"sourceItem": [
"string"
]
}
},
"commonOpts": {
"prePostOpts": {
"postRecoveryCommand": "string",
"impersonation": {
"level": "USR_LOCAL_SYS_ADMIN"
}
},
"notifyUserOnJobCompletion": true
}
}
}
}
]
}
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/createTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"taskInfo": {
"task": {},
"associations": [
{
"displayName": "string",
"clientId": 0,
"instanceName": "string",
"appName": "MySQL",
"applicationId": 104,
"clientName": "string",
"backupsetName": "defaultDummyBackupSet",
"subclientName": "string",
"subclientId": "string"
}
],
"subTasks": [
{
"subTask": {
"subTaskType": "RESTORE",
"operationType": "RESTORE"
},
"options": {
"restoreOptions": {
"browseOption": {
"commCellId": 0,
"backupset": {
"backupsetId": 0,
"clientId": 0
},
"noImage": true,
"useExactIndex": true,
"mediaOption": {
"copyPrecedence": {
"copyPrecedenceApplicable": true
}
},
"listMedia": true,
"timeRange": {
"fromTime": 0,
"toTime": 0
}
},
"destination": {
"destClient": {
"clientName": "string",
"clientId": 0
},
"destinationInstance": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"instanceId": 0,
"clientId": 0,
"appName": "MySQL",
"applicationId": 104
}
},
"mySqlRstOption": {
"pointofTime": true,
"fromTime": {
"time": 0
},
"refTime": {
"time": 0
},
"destinationServer": {
"name": "string",
"id": 0
},
"pointInTime": {
"time": 0
},
"instanceRestore": true,
"data": true,
"log": true,
"recurringRestore": true,
"temporaryStagingLocation": "/opt/commvault/iDataAgent/jobResults",
"destinationFolder": "/opt/commvault/iDataAgent/jobResults",
"tableLevelRestore": true,
"isCloneRestore": true,
"cloneOptions": {
"isInstanceSelected": true,
"binaryDirectory": "string",
"user": "string",
"port": "string",
"stagingLocaion": "string",
"reservationPeriodS": 0,
"forceCleanup": true
},
"fileOption": {
"sourceItem": [
"string"
]
}
},
"commonOpts": {
"prePostOpts": {
"postRecoveryCommand": "string",
"impersonation": {
"level": "USR_LOCAL_SYS_ADMIN"
}
},
"notifyUserOnJobCompletion": true
}
}
}
}
]
}
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/createTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"taskInfo": {
"task": {},
"associations": [
{
"displayName": "string",
"clientId": 0,
"instanceName": "string",
"appName": "MySQL",
"applicationId": 104,
"clientName": "string",
"backupsetName": "defaultDummyBackupSet",
"subclientName": "string",
"subclientId": "string"
}
],
"subTasks": [
{
"subTask": {
"subTaskType": "RESTORE",
"operationType": "RESTORE"
},
"options": {
"restoreOptions": {
"browseOption": {
"commCellId": 0,
"backupset": {
"backupsetId": 0,
"clientId": 0
},
"noImage": true,
"useExactIndex": true,
"mediaOption": {
"copyPrecedence": {
"copyPrecedenceApplicable": true
}
},
"listMedia": true,
"timeRange": {
"fromTime": 0,
"toTime": 0
}
},
"destination": {
"destClient": {
"clientName": "string",
"clientId": 0
},
"destinationInstance": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"instanceId": 0,
"clientId": 0,
"appName": "MySQL",
"applicationId": 104
}
},
"mySqlRstOption": {
"pointofTime": true,
"fromTime": {
"time": 0
},
"refTime": {
"time": 0
},
"destinationServer": {
"name": "string",
"id": 0
},
"pointInTime": {
"time": 0
},
"instanceRestore": true,
"data": true,
"log": true,
"recurringRestore": true,
"temporaryStagingLocation": "/opt/commvault/iDataAgent/jobResults",
"destinationFolder": "/opt/commvault/iDataAgent/jobResults",
"tableLevelRestore": true,
"isCloneRestore": true,
"cloneOptions": {
"isInstanceSelected": true,
"binaryDirectory": "string",
"user": "string",
"port": "string",
"stagingLocaion": "string",
"reservationPeriodS": 0,
"forceCleanup": true
},
"fileOption": {
"sourceItem": [
"string"
]
}
},
"commonOpts": {
"prePostOpts": {
"postRecoveryCommand": "string",
"impersonation": {
"level": "USR_LOCAL_SYS_ADMIN"
}
},
"notifyUserOnJobCompletion": true
}
}
}
}
]
}
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/createTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"taskInfo": {
"task": {},
"associations": [
{
"displayName": "string",
"clientId": 0,
"instanceName": "string",
"appName": "MySQL",
"applicationId": 104,
"clientName": "string",
"backupsetName": "defaultDummyBackupSet",
"subclientName": "string",
"subclientId": "string"
}
],
"subTasks": [
{
"subTask": {
"subTaskType": "RESTORE",
"operationType": "RESTORE"
},
"options": {
"restoreOptions": {
"browseOption": {
"commCellId": 0,
"backupset": {
"backupsetId": 0,
"clientId": 0
},
"noImage": true,
"useExactIndex": true,
"mediaOption": {
"copyPrecedence": {
"copyPrecedenceApplicable": true
}
},
"listMedia": true,
"timeRange": {
"fromTime": 0,
"toTime": 0
}
},
"destination": {
"destClient": {
"clientName": "string",
"clientId": 0
},
"destinationInstance": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"instanceId": 0,
"clientId": 0,
"appName": "MySQL",
"applicationId": 104
}
},
"mySqlRstOption": {
"pointofTime": true,
"fromTime": {
"time": 0
},
"refTime": {
"time": 0
},
"destinationServer": {
"name": "string",
"id": 0
},
"pointInTime": {
"time": 0
},
"instanceRestore": true,
"data": true,
"log": true,
"recurringRestore": true,
"temporaryStagingLocation": "/opt/commvault/iDataAgent/jobResults",
"destinationFolder": "/opt/commvault/iDataAgent/jobResults",
"tableLevelRestore": true,
"isCloneRestore": true,
"cloneOptions": {
"isInstanceSelected": true,
"binaryDirectory": "string",
"user": "string",
"port": "string",
"stagingLocaion": "string",
"reservationPeriodS": 0,
"forceCleanup": true
},
"fileOption": {
"sourceItem": [
"string"
]
}
},
"commonOpts": {
"prePostOpts": {
"postRecoveryCommand": "string",
"impersonation": {
"level": "USR_LOCAL_SYS_ADMIN"
}
},
"notifyUserOnJobCompletion": true
}
}
}
}
]
}
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/createTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"taskInfo": {
"task": {},
"associations": [
{
"displayName": "string",
"clientId": 0,
"instanceName": "string",
"appName": "MySQL",
"applicationId": 104,
"clientName": "string",
"backupsetName": "defaultDummyBackupSet",
"subclientName": "string",
"subclientId": "string"
}
],
"subTasks": [
{
"subTask": {
"subTaskType": "RESTORE",
"operationType": "RESTORE"
},
"options": {
"restoreOptions": {
"browseOption": {
"commCellId": 0,
"backupset": {
"backupsetId": 0,
"clientId": 0
},
"noImage": true,
"useExactIndex": true,
"mediaOption": {
"copyPrecedence": {
"copyPrecedenceApplicable": true
}
},
"listMedia": true,
"timeRange": {
"fromTime": 0,
"toTime": 0
}
},
"destination": {
"destClient": {
"clientName": "string",
"clientId": 0
},
"destinationInstance": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"instanceId": 0,
"clientId": 0,
"appName": "MySQL",
"applicationId": 104
}
},
"mySqlRstOption": {
"pointofTime": true,
"fromTime": {
"time": 0
},
"refTime": {
"time": 0
},
"destinationServer": {
"name": "string",
"id": 0
},
"pointInTime": {
"time": 0
},
"instanceRestore": true,
"data": true,
"log": true,
"recurringRestore": true,
"temporaryStagingLocation": "/opt/commvault/iDataAgent/jobResults",
"destinationFolder": "/opt/commvault/iDataAgent/jobResults",
"tableLevelRestore": true,
"isCloneRestore": true,
"cloneOptions": {
"isInstanceSelected": true,
"binaryDirectory": "string",
"user": "string",
"port": "string",
"stagingLocaion": "string",
"reservationPeriodS": 0,
"forceCleanup": true
},
"fileOption": {
"sourceItem": [
"string"
]
}
},
"commonOpts": {
"prePostOpts": {
"postRecoveryCommand": "string",
"impersonation": {
"level": "USR_LOCAL_SYS_ADMIN"
}
},
"notifyUserOnJobCompletion": true
}
}
}
}
]
}
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/createTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"taskInfo": {
"task": {},
"associations": [
{
"displayName": "string",
"clientId": 0,
"instanceName": "string",
"appName": "MySQL",
"applicationId": 104,
"clientName": "string",
"backupsetName": "defaultDummyBackupSet",
"subclientName": "string",
"subclientId": "string"
}
],
"subTasks": [
{
"subTask": {
"subTaskType": "RESTORE",
"operationType": "RESTORE"
},
"options": {
"restoreOptions": {
"browseOption": {
"commCellId": 0,
"backupset": {
"backupsetId": 0,
"clientId": 0
},
"noImage": true,
"useExactIndex": true,
"mediaOption": {
"copyPrecedence": {
"copyPrecedenceApplicable": true
}
},
"listMedia": true,
"timeRange": {
"fromTime": 0,
"toTime": 0
}
},
"destination": {
"destClient": {
"clientName": "string",
"clientId": 0
},
"destinationInstance": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"instanceId": 0,
"clientId": 0,
"appName": "MySQL",
"applicationId": 104
}
},
"mySqlRstOption": {
"pointofTime": true,
"fromTime": {
"time": 0
},
"refTime": {
"time": 0
},
"destinationServer": {
"name": "string",
"id": 0
},
"pointInTime": {
"time": 0
},
"instanceRestore": true,
"data": true,
"log": true,
"recurringRestore": true,
"temporaryStagingLocation": "/opt/commvault/iDataAgent/jobResults",
"destinationFolder": "/opt/commvault/iDataAgent/jobResults",
"tableLevelRestore": true,
"isCloneRestore": true,
"cloneOptions": {
"isInstanceSelected": true,
"binaryDirectory": "string",
"user": "string",
"port": "string",
"stagingLocaion": "string",
"reservationPeriodS": 0,
"forceCleanup": true
},
"fileOption": {
"sourceItem": [
"string"
]
}
},
"commonOpts": {
"prePostOpts": {
"postRecoveryCommand": "string",
"impersonation": {
"level": "USR_LOCAL_SYS_ADMIN"
}
},
"notifyUserOnJobCompletion": true
}
}
}
}
]
}
}'
curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/createTask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"taskInfo": {
"task": {},
"associations": [
{
"displayName": "string",
"clientId": 0,
"instanceName": "string",
"appName": "MySQL",
"applicationId": 104,
"clientName": "string",
"backupsetName": "defaultDummyBackupSet",
"subclientName": "string",
"subclientId": "string"
}
],
"subTasks": [
{
"subTask": {
"subTaskType": "RESTORE",
"operationType": "RESTORE"
},
"options": {
"restoreOptions": {
"browseOption": {
"commCellId": 0,
"backupset": {
"backupsetId": 0,
"clientId": 0
},
"noImage": true,
"useExactIndex": true,
"mediaOption": {
"copyPrecedence": {
"copyPrecedenceApplicable": true
}
},
"listMedia": true,
"timeRange": {
"fromTime": 0,
"toTime": 0
}
},
"destination": {
"destClient": {
"clientName": "string",
"clientId": 0
},
"destinationInstance": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"instanceId": 0,
"clientId": 0,
"appName": "MySQL",
"applicationId": 104
}
},
"mySqlRstOption": {
"pointofTime": true,
"fromTime": {
"time": 0
},
"refTime": {
"time": 0
},
"destinationServer": {
"name": "string",
"id": 0
},
"pointInTime": {
"time": 0
},
"instanceRestore": true,
"data": true,
"log": true,
"recurringRestore": true,
"temporaryStagingLocation": "/opt/commvault/iDataAgent/jobResults",
"destinationFolder": "/opt/commvault/iDataAgent/jobResults",
"tableLevelRestore": true,
"isCloneRestore": true,
"cloneOptions": {
"isInstanceSelected": true,
"binaryDirectory": "string",
"user": "string",
"port": "string",
"stagingLocaion": "string",
"reservationPeriodS": 0,
"forceCleanup": true
},
"fileOption": {
"sourceItem": [
"string"
]
}
},
"commonOpts": {
"prePostOpts": {
"postRecoveryCommand": "string",
"impersonation": {
"level": "USR_LOCAL_SYS_ADMIN"
}
},
"notifyUserOnJobCompletion": true
}
}
}
}
]
}
}'