MySQL Backup Operations
Select
SaaS
Customer Managed
This operation is used to run MySQL backups
- application/json
Request Body
taskInfo object
task object
taskType requiredPossible values: [
IMMEDIATE
,SCHEDULE
]associations object[] required
instanceName string requiredMySQL Instance name
appName string requiredDefault value:
MySQL
Application Name
clientName string requiredDatabase Server name
subclientName string requiredDatabase group name
subTasks object[]
subTask object required
subTaskType string requiredDefault value:
BACKUP
operationType string requiredDefault value:
BACKUP
options object
backupOpts object
Backup Options
backupLevel requiredPossible values: [
FULL
,INCREMENTAL
,SYNTHETIC_FULL
]incLevel string requireddoNotTruncateLog booleanPurge Binary logs
truncateLogsOnSource booleanProxy Backup option to Purge binary logs on Source MySQL Instance
incrementalDataWithLogs booleanIncremental Backup with Logs (applicable for MySQL Block Level backup and Full Instance Xtrabackup)
commonOpts object
notifyUserOnJobCompletion boolean
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
}
Loading...