Skip to main content

HANA Restore operation​

Select

SaaS
Customer Managed

SAP HANA Restore operation

Request Body
  • taskInfo object
  • task object
  • taskType string required

    Possible values: [IMMEDIATE, SCHEDULE_POLICY]

  • associations object[]
  • clientId integer required

    HANA source Pseudo clientId

  • instanceName string required

    HANA source Insatcne Name

  • appName string

    Default value: SAP HANA

  • applicationId integer

    Default value: 135

  • clientName string required

    HANA source Pseudo client name

  • backupsetId integer required

    HANA source client Backupset ID

  • instanceId integer required

    HANA source Instance ID

  • backupsetName string required

    HANA source Backupset name

  • subTasks object[]
  • subTask object
  • subTaskType string

    Default value: RESTORE

  • operationType string

    Default value: RESTORE

  • options object
  • restoreOptions object
  • browseOption object
  • commCellId integer

    Default value: 2

  • timeRange object

    Restore time range

  • fromTime integer
  • toTime integer
  • mediaOption object
  • copyPrecedence object
  • copyPrecedenceApplicable boolean

    Default value: true

  • copyPrecedence integer
  • destination object
  • destClient object
  • clientId integer required

    HANA Target clientID

  • clientName string required

    HANA Target client name

  • destinationInstance object
  • instanceId integer required

    HANA Target Instance ID

  • instanceName string required

    HANA Target Instance name

  • applicationId integer

    Default value: 135

  • appName string

    Default value: SAP HANA

  • clientId integer required

    HANA target Pseudo client id

  • clientName string required

    HANA target Pseudo client name

  • noOfStreams integer

    Default value: 2

  • destinationBackupset object
  • backupsetId integer required

    HANA target Backupset ID

  • backupsetName string required

    HANA target Backupset name

  • instanceId integer required

    HANA target Instance ID

  • instanceName string required

    HANA target Instance name

  • applicationId integer

    Default value: 135

  • appName string

    Default value: SAP HANA

  • clientId integer required

    HANA target Pseudo client ID

  • clientName string required

    HANA target Pseudo client name

  • entityInfo object
  • companyId integer
  • companyName string

    Default value: Commcell

  • commonOptions object
  • unconditionalOverwrite boolean

    Default value: true

  • hanaOpt object
  • destDbName string required

    HANA target Database name

  • destPseudoClientName string required

    HANA target Pseudo client name

  • destClientName string required

    HANA target Physical client name

  • pointInTime object
  • time integer required

    POINT IN TIME recovery

  • useHardwareRevert boolean

    Default value: false

    Hardware Revert only applicable for Snap backup

  • destinationInstanceDir string

    Default value: /hana/data/

    Hana target DATA directory

  • checkAccess boolean

    Default value: true

  • initializeLogArea boolean

    Default value: true

    Initialize log area option for HANA DB Recovery

  • ignoreDeltaBackups boolean

    Default value: false

    Delta backup option

  • databases string[] required

    Source Database name

  • recoverTime string required

    Recovery POINT_IN_TIME

  • commonOpts object
  • notifyUserOnJobCompletion boolean

    Default value: true

Responses

OK

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

Authorization

type: apiKeyname: Authtokenin: header

Request

Security Scheme
token
Body
{

  "taskInfo": {

    "task": {

      "taskType": "string"

    },

    "associations": [

      {

        "clientId": 0,

        "instanceName": "string",

        "appName": "SAP HANA",

        "applicationId": 135,

        "clientName": "string",

        "backupsetId": 0,

        "instanceId": 0,

        "backupsetName": "string"

      }

    ],

    "subTasks": [

      {

        "subTask": {

          "subTaskType": "RESTORE",

          "operationType": "RESTORE"

        },

        "options": {

          "restoreOptions": {

            "browseOption": {

              "commCellId": 2,

              "timeRange": {

                "fromTime": 0,

                "toTime": 0

              },

              "mediaOption": {

                "copyPrecedence": {

                  "copyPrecedenceApplicable": true,

                  "copyPrecedence": 0

                }

              }

            },

            "destination": {

              "destClient": {

                "clientId": 0,

                "clientName": "string"

              },

              "destinationInstance": {

                "instanceId": 0,

                "instanceName": "string",

                "applicationId": 135,

                "appName": "SAP HANA",

                "clientId": 0,

                "clientName": "string"

              },

              "noOfStreams": 2,

              "destinationBackupset": {

                "backupsetId": 0,

                "backupsetName": "string",

                "instanceId": 0,

                "instanceName": "string",

                "applicationId": 135,

                "appName": "SAP HANA",

                "clientId": 0,

                "clientName": "string",

                "entityInfo": {

                  "companyId": 0,

                  "companyName": "Commcell"

                }

              }

            },

            "commonOptions": {

              "unconditionalOverwrite": true

            },

            "hanaOpt": {

              "destDbName": "string",

              "destPseudoClientName": "string",

              "destClientName": "string",

              "pointInTime": {

                "time": 0

              },

              "useHardwareRevert": false,

              "destinationInstanceDir": "/hana/data/",

              "checkAccess": true,

              "initializeLogArea": true,

              "ignoreDeltaBackups": false,

              "databases": [

                "string"

              ],

              "recoverTime": "string"

            }

          },

          "commonOpts": {

            "notifyUserOnJobCompletion": true

          }

        }

      }

    ]

  }

}

curl -L -X POST 'https://api.commvault.com/CreatetasK' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "task": {
      "taskType": "string"
    },
    "associations": [
      {
        "clientId": 0,
        "instanceName": "string",
        "appName": "SAP HANA",
        "applicationId": 135,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "backupsetName": "string"
      }
    ],
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "RESTORE",
          "operationType": "RESTORE"
        },
        "options": {
          "restoreOptions": {
            "browseOption": {
              "commCellId": 2,
              "timeRange": {
                "fromTime": 0,
                "toTime": 0
              },
              "mediaOption": {
                "copyPrecedence": {
                  "copyPrecedenceApplicable": true,
                  "copyPrecedence": 0
                }
              }
            },
            "destination": {
              "destClient": {
                "clientId": 0,
                "clientName": "string"
              },
              "destinationInstance": {
                "instanceId": 0,
                "instanceName": "string",
                "applicationId": 135,
                "appName": "SAP HANA",
                "clientId": 0,
                "clientName": "string"
              },
              "noOfStreams": 2,
              "destinationBackupset": {
                "backupsetId": 0,
                "backupsetName": "string",
                "instanceId": 0,
                "instanceName": "string",
                "applicationId": 135,
                "appName": "SAP HANA",
                "clientId": 0,
                "clientName": "string",
                "entityInfo": {
                  "companyId": 0,
                  "companyName": "Commcell"
                }
              }
            },
            "commonOptions": {
              "unconditionalOverwrite": true
            },
            "hanaOpt": {
              "destDbName": "string",
              "destPseudoClientName": "string",
              "destClientName": "string",
              "pointInTime": {
                "time": 0
              },
              "useHardwareRevert": false,
              "destinationInstanceDir": "/hana/data/",
              "checkAccess": true,
              "initializeLogArea": true,
              "ignoreDeltaBackups": false,
              "databases": [
                "string"
              ],
              "recoverTime": "string"
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'