Skip to main content

Restoring a MongoDB cluster in place​

Select

SaaS
Customer Managed

This operation is used to restore a cluster in place.

Request Body
  • taskInfo object
  • task object
  • taskType string

    Default value: IMMEDIATE

  • initiatedFrom string

    Default value: GUI

  • associations object[]
  • subclientId integer required

    Subclient id of the MongoDB instance

  • timeZone object
  • displayName string required

    MongoDB client instance display name

  • clientId integer required

    MongoDB instance client Id

  • instanceName string required

    MongoDB instanc

  • client object
  • owner object
  • appName string

    Default value: Big Data Apps

  • applicationId integer

    Default value: 64

  • clientName string required

    MongoDB client inst

  • backupsetId integer
  • instanceId integer required

    MongoDB instance Id

  • commCellId integer

    Commcell Id

  • subtask object
  • _type_ string

    Default value: INSTANCE_ENTITY

    "INSTANCE_ENTITY"

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

    Default value: RESTORE

    "RESTORE"

  • operationType string required

    Default value: RESTORE

    "RESTORE"

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

    Commcell ID

  • backupset object
  • backupsetId integer

    backupset Id

  • clientId integer

    MongoDB client ID

  • destination object
  • destClient object
  • clientId integer required

    MongoDB destination client Id

  • clientName string required

    MongoDB destination

  • destinationInstance object
  • instanceId integer required

    Destination MongoDB instance Id

  • instanceName string

    Destination MongoDB

  • applicationId integer

    Default value: 64

    64

  • appName string

    Default value: Big Data Apps

    "Big Data Apps"

  • clientId integer

    Destination MongoDB client Id

  • clientName string

    Dest

  • noOfStreams integer

    Number of streams

  • qrOption object
  • destAppTypeId integer

    Default value: 64

    64

  • fileOption object
  • sourceItem string[]

    "/"

  • commonOptions object
  • unconditionalOverwrite boolean
  • distributedAppsRestoreOptions object
  • distributedRestore boolean

    Default value: true

  • mongoDBRestoreOptions object
  • destShardList object[]
  • srcShardName string

    Source shard name

  • destShardName string

    Destination shard name

  • target object

    Since it is an in place restore target information is same as the source

  • clientId integer

    Destination cluster master node id

  • clientName string

    Destination cluster master node name

  • hostName string

    Destination cluster master hostname

  • destHostName string
  • destPortNumber integer
  • destDataDir string
  • bkpSecondary object
  • clientId integer
  • clientName string
  • hostName string
  • bkpHostName string
  • bkpPortNumber integer
  • bkpDataDir string
  • primaryPortNumber integer
  • aFileId integer
  • useDestAsSecondary boolean
  • restoreFilesOnly boolean
  • recover boolean
  • pointInTimeToEndOfBackup boolean
  • latestOpLogSync boolean
  • latestEndOfBackup boolean
  • isGranularRecovery boolean
  • autoDBShutDown boolean
  • isInplaceRestore boolean
Responses

OK

Schema
  • processinginstructioninfo object
  • attributes object[]
  • name string
  • value string
  • 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": {

    "task": {

      "taskType": "IMMEDIATE",

      "initiatedFrom": "GUI"

    },

    "associations": [

      {

        "subclientId": 0,

        "timeZone": {},

        "displayName": "string",

        "clientId": 0,

        "instanceName": "string",

        "client": {},

        "owner": {},

        "appName": "Big Data Apps",

        "applicationId": 64,

        "clientName": "string",

        "backupsetId": 0,

        "instanceId": 0,

        "commCellId": 0,

        "subtask": {},

        "_type_": "INSTANCE_ENTITY"

      }

    ],

    "subTasks": [

      {

        "subTask": {

          "subTaskType": "RESTORE",

          "operationType": "RESTORE"

        },

        "options": {

          "restoreOptions": {

            "browseOption": {

              "commCellId": 0,

              "backupset": {

                "backupsetId": 0,

                "clientId": 0

              }

            },

            "destination": {

              "destClient": {

                "clientId": 0,

                "clientName": "string"

              },

              "destinationInstance": {

                "instanceId": 0,

                "instanceName": "string",

                "applicationId": 64,

                "appName": "Big Data Apps",

                "clientId": 0,

                "clientName": "string"

              },

              "noOfStreams": 0

            },

            "qrOption": {

              "destAppTypeId": 64

            },

            "fileOption": {

              "sourceItem": [

                "/"

              ]

            },

            "commonOptions": {

              "unconditionalOverwrite": true

            },

            "distributedAppsRestoreOptions": {

              "distributedRestore": true,

              "mongoDBRestoreOptions": {

                "destShardList": [

                  {

                    "srcShardName": "string",

                    "destShardName": "string",

                    "target": {

                      "clientId": 0,

                      "clientName": "string",

                      "hostName": "string"

                    },

                    "destHostName": "string",

                    "destPortNumber": 0,

                    "destDataDir": "string",

                    "bkpSecondary": {

                      "clientId": 0,

                      "clientName": "string",

                      "hostName": "string"

                    },

                    "bkpHostName": "string",

                    "bkpPortNumber": 0,

                    "bkpDataDir": "string",

                    "primaryPortNumber": 0,

                    "aFileId": 0,

                    "useDestAsSecondary": true

                  }

                ],

                "restoreFilesOnly": true,

                "recover": true,

                "pointInTimeToEndOfBackup": true,

                "latestOpLogSync": true,

                "latestEndOfBackup": true,

                "isGranularRecovery": true,

                "autoDBShutDown": true,

                "isInplaceRestore": 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": {
    "task": {
      "taskType": "IMMEDIATE",
      "initiatedFrom": "GUI"
    },
    "associations": [
      {
        "subclientId": 0,
        "timeZone": {},
        "displayName": "string",
        "clientId": 0,
        "instanceName": "string",
        "client": {},
        "owner": {},
        "appName": "Big Data Apps",
        "applicationId": 64,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "commCellId": 0,
        "subtask": {},
        "_type_": "INSTANCE_ENTITY"
      }
    ],
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "RESTORE",
          "operationType": "RESTORE"
        },
        "options": {
          "restoreOptions": {
            "browseOption": {
              "commCellId": 0,
              "backupset": {
                "backupsetId": 0,
                "clientId": 0
              }
            },
            "destination": {
              "destClient": {
                "clientId": 0,
                "clientName": "string"
              },
              "destinationInstance": {
                "instanceId": 0,
                "instanceName": "string",
                "applicationId": 64,
                "appName": "Big Data Apps",
                "clientId": 0,
                "clientName": "string"
              },
              "noOfStreams": 0
            },
            "qrOption": {
              "destAppTypeId": 64
            },
            "fileOption": {
              "sourceItem": [
                "/"
              ]
            },
            "commonOptions": {
              "unconditionalOverwrite": true
            },
            "distributedAppsRestoreOptions": {
              "distributedRestore": true,
              "mongoDBRestoreOptions": {
                "destShardList": [
                  {
                    "srcShardName": "string",
                    "destShardName": "string",
                    "target": {
                      "clientId": 0,
                      "clientName": "string",
                      "hostName": "string"
                    },
                    "destHostName": "string",
                    "destPortNumber": 0,
                    "destDataDir": "string",
                    "bkpSecondary": {
                      "clientId": 0,
                      "clientName": "string",
                      "hostName": "string"
                    },
                    "bkpHostName": "string",
                    "bkpPortNumber": 0,
                    "bkpDataDir": "string",
                    "primaryPortNumber": 0,
                    "aFileId": 0,
                    "useDestAsSecondary": true
                  }
                ],
                "restoreFilesOnly": true,
                "recover": true,
                "pointInTimeToEndOfBackup": true,
                "latestOpLogSync": true,
                "latestEndOfBackup": true,
                "isGranularRecovery": true,
                "autoDBShutDown": true,
                "isInplaceRestore": true
              }
            }
          }
        }
      }
    ]
  }
}'