Restoring a MongoDB cluster in place
This operation is used to restore a cluster in place.
- application/json
Request Body
taskInfo object
task object
taskType stringDefault value:
IMMEDIATE
initiatedFrom stringDefault value:
GUI
associations object[]
subclientId integer requiredSubclient id of the MongoDB instance
timeZone objectdisplayName string requiredMongoDB client instance display name
clientId integer requiredMongoDB instance client Id
instanceName string requiredMongoDB instanc
client objectowner objectappName stringDefault value:
Big Data Apps
applicationId integerDefault value:
64
clientName string requiredMongoDB client inst
backupsetId integerinstanceId integer requiredMongoDB instance Id
commCellId integerCommcell Id
subtask object_type_ stringDefault value:
INSTANCE_ENTITY
"INSTANCE_ENTITY"
subTasks object[]
subTask object
subTaskType string requiredDefault value:
RESTORE
"RESTORE"
operationType string requiredDefault value:
RESTORE
"RESTORE"
options object
restoreOptions object
browseOption object
commCellId integer requiredCommcell ID
backupset object
backupsetId integerbackupset Id
clientId integerMongoDB client ID
destination object
destClient object
clientId integer requiredMongoDB destination client Id
clientName string requiredMongoDB destination
destinationInstance object
instanceId integer requiredDestination MongoDB instance Id
instanceName stringDestination MongoDB
applicationId integerDefault value:
64
64
appName stringDefault value:
Big Data Apps
"Big Data Apps"
clientId integerDestination MongoDB client Id
clientName stringDest
noOfStreams integerNumber of streams
qrOption object
destAppTypeId integerDefault value:
64
64
fileOption object
sourceItem string[]"/"
commonOptions object
unconditionalOverwrite booleandistributedAppsRestoreOptions object
distributedRestore booleanDefault value:
true
mongoDBRestoreOptions object
destShardList object[]
srcShardName stringSource shard name
destShardName stringDestination shard name
target object
Since it is an in place restore target information is same as the source
clientId integerDestination cluster master node id
clientName stringDestination cluster master node name
hostName stringDestination cluster master hostname
destHostName stringdestPortNumber integerdestDataDir stringbkpSecondary object
clientId integerclientName stringhostName stringbkpHostName stringbkpPortNumber integerbkpDataDir stringprimaryPortNumber integeraFileId integeruseDestAsSecondary booleanrestoreFilesOnly booleanrecover booleanpointInTimeToEndOfBackup booleanlatestOpLogSync booleanlatestEndOfBackup booleanisGranularRecovery booleanautoDBShutDown booleanisInplaceRestore boolean
- 200
- 400
- 401
- 404
OK
- application/json
- Schema
- Example (from schema)
Schema
processinginstructioninfo object
attributes object[]
name stringvalue string- taskId integer
- jobIds string[]
{
"processinginstructioninfo": {
"attributes": [
{
"name": "string",
"value": "string"
}
]
},
"taskId": 0,
"jobIds": [
"string"
]
}
Bad Request
- application/json
- Schema
- Example 1
Schema
- string
Request body is empty or format is invalid
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "string",
"errorCode": 0
}
Not Found
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "No instance is specified",
"errorCode": 4
}