Skip to main content

MySQL Restore Operations​

This operation is used to run MySQL restores

Request Body
  • taskInfo object
  • task object
  • taskType required

    Possible values: [IMMEDIATE, SCHEDULE]

  • associations object[]
  • displayName string

    Client display name

  • clientId integer
  • instanceName string required

    Source MySQL Instance name

  • appName string required

    Default value: MySQL

    Application name

  • applicationId integer

    Default value: 104

    104 for MySQL

  • clientName string required

    Source MySQL Client name

  • backupsetName string required

    Default value: defaultDummyBackupSet

    Backupset Name

  • subclientName string

    Database group name if the restore is initiated from database group level

  • subclientId string

    Database group ID when restore to be initiated from database group level

  • subTasks object[]
  • subTask object
  • subTaskType string required

    Default value: RESTORE

  • operationType string required

    Default value: RESTORE

  • options object
  • restoreOptions object
  • browseOption object
  • commCellId integer
  • backupset object
  • backupsetId integer
  • clientId integer
  • noImage boolean
  • useExactIndex boolean
  • mediaOption object
  • copyPrecedence object
  • copyPrecedenceApplicable boolean
  • listMedia boolean
  • timeRange object
  • fromTime integer

    From time in epoch

  • toTime integer

    To time in epoch

  • destination object
  • destClient object
  • clientName string required

    Destination Client Name

  • clientId integer

    Destination Client ID

  • destinationInstance object
  • clientName string required

    Destination Client Name

  • instanceName string required

    Destinaton MySQL Instance name

  • displayName string

    Destination client display name

  • instanceId integer

    Destination MySQL instance ID

  • clientId integer

    Destination client ID

  • appName string required

    Default value: MySQL

  • applicationId integer

    Default value: 104

  • mySqlRstOption object

    MySQL Restore options

  • pointofTime boolean

    Is the restore Point in Time

  • fromTime object
  • time integer
  • refTime object
  • time integer
  • destinationServer object required
  • name string required

    Destination MySQL Instance name

  • id integer

    Destination MySQL Instance ID

  • pointInTime object
  • time integer
  • instanceRestore boolean
  • data boolean

    Flag for data only restore

  • log boolean

    Flag for Log only restore

  • recurringRestore boolean
  • logRestoreType

    Possible values: [RECOVER, DO_NOT_RECOVER]

    Restore type

  • temporaryStagingLocation string

    Default value: /opt/commvault/iDataAgent/jobResults

    Staging location

  • destinationFolder string

    Default value: /opt/commvault/iDataAgent/jobResults

    Destination Folder for Restore to Disk

  • tableLevelRestore boolean

    Table level restore supported with MySQL Block Level backups

  • isCloneRestore boolean

    Instant Clone restore

  • cloneOptions object
  • isInstanceSelected boolean

    Source MySQL Instance id for fetching MySQL binary directory

  • binaryDirectory string

    Binary directory of Source MySQL Instance

  • user string
  • port string

    Port number for Clone MySQL Server

  • stagingLocaion string
  • reservationPeriodS integer

    Reserve Clone for time (in seconds)

  • forceCleanup boolean

    Clone clean up after reserved time

  • fileOption object
  • sourceItem string[]

    Databases list to be restored

  • commonOpts object
  • prePostOpts object
  • postRecoveryCommand string

    Post recovery commnad after clone operation

  • impersonation object

    Impersonate user for Clone Operation

  • level string

    Default value: USR_LOCAL_SYS_ADMIN

  • notifyUserOnJobCompletion boolean
Responses

OK

Response Headers
    Schema
    • taskId integer
    • jobIds string[]

      JobId of install job triggered

    Loading...