MySQL Backup Operations
This operation is used to run MySQL backups
- 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 [Data Protection/Management Operations] for this client [mysql_win] and this operation.",
"errorCode": 587203022
}
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": [
{
"instanceName": "string",
"appName": "MySQL",
"clientName": "string",
"subclientName": "string"
}
],
"subTasks": [
{
"subTask": {
"subTaskType": "BACKUP",
"operationType": "BACKUP"
},
"options": {
"backupOpts": {
"incLevel": "string",
"doNotTruncateLog": true,
"truncateLogsOnSource": true,
"incrementalDataWithLogs": true
},
"commonOpts": {
"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": [
{
"instanceName": "string",
"appName": "MySQL",
"clientName": "string",
"subclientName": "string"
}
],
"subTasks": [
{
"subTask": {
"subTaskType": "BACKUP",
"operationType": "BACKUP"
},
"options": {
"backupOpts": {
"incLevel": "string",
"doNotTruncateLog": true,
"truncateLogsOnSource": true,
"incrementalDataWithLogs": true
},
"commonOpts": {
"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": [
{
"instanceName": "string",
"appName": "MySQL",
"clientName": "string",
"subclientName": "string"
}
],
"subTasks": [
{
"subTask": {
"subTaskType": "BACKUP",
"operationType": "BACKUP"
},
"options": {
"backupOpts": {
"incLevel": "string",
"doNotTruncateLog": true,
"truncateLogsOnSource": true,
"incrementalDataWithLogs": true
},
"commonOpts": {
"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": [
{
"instanceName": "string",
"appName": "MySQL",
"clientName": "string",
"subclientName": "string"
}
],
"subTasks": [
{
"subTask": {
"subTaskType": "BACKUP",
"operationType": "BACKUP"
},
"options": {
"backupOpts": {
"incLevel": "string",
"doNotTruncateLog": true,
"truncateLogsOnSource": true,
"incrementalDataWithLogs": true
},
"commonOpts": {
"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": [
{
"instanceName": "string",
"appName": "MySQL",
"clientName": "string",
"subclientName": "string"
}
],
"subTasks": [
{
"subTask": {
"subTaskType": "BACKUP",
"operationType": "BACKUP"
},
"options": {
"backupOpts": {
"incLevel": "string",
"doNotTruncateLog": true,
"truncateLogsOnSource": true,
"incrementalDataWithLogs": true
},
"commonOpts": {
"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": [
{
"instanceName": "string",
"appName": "MySQL",
"clientName": "string",
"subclientName": "string"
}
],
"subTasks": [
{
"subTask": {
"subTaskType": "BACKUP",
"operationType": "BACKUP"
},
"options": {
"backupOpts": {
"incLevel": "string",
"doNotTruncateLog": true,
"truncateLogsOnSource": true,
"incrementalDataWithLogs": true
},
"commonOpts": {
"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": [
{
"instanceName": "string",
"appName": "MySQL",
"clientName": "string",
"subclientName": "string"
}
],
"subTasks": [
{
"subTask": {
"subTaskType": "BACKUP",
"operationType": "BACKUP"
},
"options": {
"backupOpts": {
"incLevel": "string",
"doNotTruncateLog": true,
"truncateLogsOnSource": true,
"incrementalDataWithLogs": true
},
"commonOpts": {
"notifyUserOnJobCompletion": true
}
}
}
]
}
}'