Skip to main content

AWS Oracle RDS Export Instance Restore​

This API allows you to restore backed up database to any on-premise or database present on cloud vm.

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

    Cloud Account name

  • instanceName string

    RDS instance name

  • displayName string

    Display name of the cloud account

  • applicationId integer

    Default value: 22

  • entityInfo object
  • companyId integer
  • companyName string

    Default value: COMMCELL

  • cloudInstanceType string

    Default value: ORACLE_RDS

  • task object
  • taskType integer

    Default value: 1

  • subTasks object[]
  • subTask object
  • subTaskType integer

    Default value: 3

  • operationType integer

    Default value: 1005

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

    Default value: 2

  • timeRange object
  • fromTime integer

    Data browse from time

  • toTime integer

    Data browse to time

  • browseJobCommCellId integer

    Default value: 2

  • destination object
  • inPlace boolean

    Default value: false

  • destClient object
  • clientId integer

    Destination Client Name

  • clientName string

    Destination Client ID

  • destPath string[]

    Destination staging path

  • noOfStreams integer

    Number of data streams

  • destinationInstance object
  • applicationId integer

    Default value: 22

  • instanceName string

    Name of destination instance

  • oracleOpt object
  • restoreStream integer

    Number of restore streams

  • noCatalog boolean

    Default value: true

  • restoreData boolean

    Set to true if data is restored

  • recover boolean

    Set to true if recovery needs to be performed on the database.

  • recoverFrom string

    Possible values: [0- Current Time, 1- Point in Time, 2- SCN, 3- Most Recent Backup]

    Select database state to be recovered from given options Default - Point in Time

  • restoreFrom string

    Possible values: [0- Current Time, 1- Point in Time, 2- SCN, 3- Most Recent Backup]

    Select database state to be restored from given options Default - Point in Time

  • recoverSCN integer

    SCN To recover database to

  • stagingPath string

    Staging path for restore

  • redirectItemsPresent boolean

    Default value: true

  • redirectAllItemsSelected boolean

    Default value: true

  • renamePathForAllTablespaces string

    Folder to redirect items to be restore

  • redirectTempFilesSelected boolean

    Default value: true

  • crossmachineRestoreOptions object
  • onlineLogDest string

    Provide Redirect folder path

  • redirectTempFilesValue string

    Provide redirect folder path

  • rdsRmanImportOpt object
  • stagingPath string

    Staging path for restore

  • fileOption object
  • sourceItem string[]

    Array of items to be restored

  • commonOptions object
  • stripLevelType integer
  • preserveLevel integer
  • unconditionalOverwrite boolean
  • stripLevel integer
  • jobIds object[]
  • commonOpts object
  • notifyUserOnJobCompletion boolean
  • 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",

        "applicationId": 22,

        "entityInfo": {

          "companyId": 0,

          "companyName": "COMMCELL"

        },

        "cloudInstanceType": "ORACLE_RDS"

      }

    ],

    "task": {

      "taskType": 1

    },

    "subTasks": [

      {

        "subTask": {

          "subTaskType": 3,

          "operationType": 1005

        },

        "options": {

          "restoreOptions": {

            "browseOption": {

              "commCellId": 2,

              "timeRange": {

                "fromTime": 0,

                "toTime": 0

              },

              "browseJobCommCellId": 2

            },

            "destination": {

              "inPlace": false,

              "destClient": {

                "clientId": 0,

                "clientName": "string"

              },

              "destPath": [

                "string"

              ],

              "noOfStreams": 0,

              "destinationInstance": {

                "applicationId": 22,

                "instanceName": "string"

              }

            },

            "oracleOpt": {

              "restoreStream": 0,

              "noCatalog": true,

              "restoreData": true,

              "recover": true,

              "recoverFrom": "0- Current Time",

              "restoreFrom": "0- Current Time",

              "recoverSCN": 0,

              "stagingPath": "string",

              "redirectItemsPresent": true,

              "redirectAllItemsSelected": true,

              "renamePathForAllTablespaces": "string",

              "redirectTempFilesSelected": true,

              "crossmachineRestoreOptions": {

                "onlineLogDest": "string"

              },

              "redirectTempFilesValue": "string",

              "rdsRmanImportOpt": {

                "stagingPath": "string"

              }

            },

            "fileOption": {

              "sourceItem": [

                "string"

              ]

            },

            "commonOptions": {

              "stripLevelType": 0,

              "preserveLevel": 0,

              "unconditionalOverwrite": true,

              "stripLevel": 0

            },

            "jobIds": [

              {}

            ]

          },

          "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",
        "applicationId": 22,
        "entityInfo": {
          "companyId": 0,
          "companyName": "COMMCELL"
        },
        "cloudInstanceType": "ORACLE_RDS"
      }
    ],
    "task": {
      "taskType": 1
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 3,
          "operationType": 1005
        },
        "options": {
          "restoreOptions": {
            "browseOption": {
              "commCellId": 2,
              "timeRange": {
                "fromTime": 0,
                "toTime": 0
              },
              "browseJobCommCellId": 2
            },
            "destination": {
              "inPlace": false,
              "destClient": {
                "clientId": 0,
                "clientName": "string"
              },
              "destPath": [
                "string"
              ],
              "noOfStreams": 0,
              "destinationInstance": {
                "applicationId": 22,
                "instanceName": "string"
              }
            },
            "oracleOpt": {
              "restoreStream": 0,
              "noCatalog": true,
              "restoreData": true,
              "recover": true,
              "recoverFrom": "0- Current Time",
              "restoreFrom": "0- Current Time",
              "recoverSCN": 0,
              "stagingPath": "string",
              "redirectItemsPresent": true,
              "redirectAllItemsSelected": true,
              "renamePathForAllTablespaces": "string",
              "redirectTempFilesSelected": true,
              "crossmachineRestoreOptions": {
                "onlineLogDest": "string"
              },
              "redirectTempFilesValue": "string",
              "rdsRmanImportOpt": {
                "stagingPath": "string"
              }
            },
            "fileOption": {
              "sourceItem": [
                "string"
              ]
            },
            "commonOptions": {
              "stripLevelType": 0,
              "preserveLevel": 0,
              "unconditionalOverwrite": true,
              "stripLevel": 0
            },
            "jobIds": [
              {}
            ]
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true,
            "prePostOpts": {
              "preRecoveryCommand": "string",
              "postRecoveryCommand": "string",
              "runPostWhenFail": true
            }
          }
        }
      }
    ]
  }
}'