Skip to main content

AWS Export MySQL instance restore​

Select

Customer Managed

This operation is used to submit AWS Export MYSQL or Aurora MySQL instance restores.

Request Body
  • taskInfo object
  • associations object[]
  • clientName string required

    Name of the cloud account

  • instanceName string required

    Name of the instance

  • displayName string

    Display name of the cloud account

  • _type_ string required

    Possible values: [INSTANCE_ENTITY, BACKUPSET_ENTITY, SUBCLIENT_ENTITY]

  • backupsetName string required

    Default value: defaultDummyBackupSet

  • applicationId integer required

    Default value: 104

  • subclientName string

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

  • task object
  • taskType string required

    Possible values: [IMMEDIATE, SCHEDULE]

  • subTasks object[]
  • subTask object
  • subTaskType string

    Default value: RESTORE

  • operationType string

    Default value: RESTORE

  • options object
  • restoreOptions object
  • browseOption object
  • commCellId integer
  • timeRange object
  • fromTime integer
  • toTime integer
  • backupset object required
  • clientName string
  • backupsetName string
  • destination object
  • destClient object
  • clientName string required

    Destination Client Name

  • destinationInstance object
  • clientName string required

    Destination Client Name

  • instanceName string required

    Destinaton Instance name

  • displayName string

    Destination Client Display Name

  • applicationId integer required

    Default value: 104

  • fileOption object required
  • sourceItem string[]

    List of databases to restore

  • mySqlRstOption object
  • pointofTime boolean

    True if point in time restore

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

    Destination Instance name

  • data boolean required

    Default value: true

  • destinationFolder string

    Destination folder location if Restore to disk

  • pointOfTime boolean

    True if point in time restore

  • commonOpts object
  • notifyUserOnJobCompletion boolean

    Default value: true

  • prePostOpts object
  • preRecoveryCommand string
  • postRecoveryCommand string
  • runPostWhenFail boolean
Responses

OK

Schema
  • taskId integer
  • jobIds string[]
POST /createtask

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Body
{

  "taskInfo": {

    "associations": [

      {

        "clientName": "string",

        "instanceName": "string",

        "displayName": "string",

        "_type_": "INSTANCE_ENTITY",

        "backupsetName": "defaultDummyBackupSet",

        "applicationId": 104,

        "subclientName": "string"

      }

    ],

    "task": {

      "taskType": "IMMEDIATE"

    },

    "subTasks": [

      {

        "subTask": {

          "subTaskType": "RESTORE",

          "operationType": "RESTORE"

        },

        "options": {

          "restoreOptions": {

            "browseOption": {

              "commCellId": 0,

              "timeRange": {

                "fromTime": 0,

                "toTime": 0

              },

              "backupset": {

                "clientName": "string",

                "backupsetName": "string"

              }

            },

            "destination": {

              "destClient": {

                "clientName": "string"

              },

              "destinationInstance": {

                "clientName": "string",

                "instanceName": "string",

                "displayName": "string",

                "applicationId": 104

              }

            },

            "fileOption": {

              "sourceItem": [

                "string"

              ]

            },

            "mySqlRstOption": {

              "pointofTime": true,

              "refTime": {

                "time": 0

              },

              "fromTime": {

                "time": 0

              },

              "pointInTime": {

                "time": 0

              },

              "destinationServer": {

                "name": "string"

              },

              "data": true,

              "destinationFolder": "string",

              "pointOfTime": true

            }

          },

          "commonOpts": {

            "notifyUserOnJobCompletion": true,

            "prePostOpts": {

              "preRecoveryCommand": "string",

              "postRecoveryCommand": "string",

              "runPostWhenFail": 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": {
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "_type_": "INSTANCE_ENTITY",
        "backupsetName": "defaultDummyBackupSet",
        "applicationId": 104,
        "subclientName": "string"
      }
    ],
    "task": {
      "taskType": "IMMEDIATE"
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "RESTORE",
          "operationType": "RESTORE"
        },
        "options": {
          "restoreOptions": {
            "browseOption": {
              "commCellId": 0,
              "timeRange": {
                "fromTime": 0,
                "toTime": 0
              },
              "backupset": {
                "clientName": "string",
                "backupsetName": "string"
              }
            },
            "destination": {
              "destClient": {
                "clientName": "string"
              },
              "destinationInstance": {
                "clientName": "string",
                "instanceName": "string",
                "displayName": "string",
                "applicationId": 104
              }
            },
            "fileOption": {
              "sourceItem": [
                "string"
              ]
            },
            "mySqlRstOption": {
              "pointofTime": true,
              "refTime": {
                "time": 0
              },
              "fromTime": {
                "time": 0
              },
              "pointInTime": {
                "time": 0
              },
              "destinationServer": {
                "name": "string"
              },
              "data": true,
              "destinationFolder": "string",
              "pointOfTime": true
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true,
            "prePostOpts": {
              "preRecoveryCommand": "string",
              "postRecoveryCommand": "string",
              "runPostWhenFail": true
            }
          }
        }
      }
    ]
  }
}'