Full backup of a MongoDB instance
This operation is used to backup a MongoDB instance
- application/json
Request Body
taskInfo object
associations object[]
subclientId integerMongoDB
displayName string requiredMongoDB instance display name
clientId integerMongoDB instance client Id
instanceName string requiredMongoDB instance name
appName stringDefault value:
Big Data Apps
applicationId integerDefault value:
64
clientName string requiredMongoDB instance client name
backupsetId integerMongoDB backupset Id
instanceId integerMongoDB instance ID
subclientName string requiredDefault value:
default
MongoDB instance subclient name i.e. default
backupsetName string requiredDefault value:
defaultBackupSet
MongoDb instance backupset name i.e defaultBackupSet
_type_ integerDefault value:
7
task object
taskType integerDefault value:
1
subTasks object[]
subTask object
subTaskType integerDefault value:
2
operationType integerDefault value:
2
options object
backupOpts object
backupLevel integerDefault value:
1
commonOpts object
notifyUserOnJobCompletion booleanDefault value:
false
subscriptionInfo string
Responses
- 200
- 400
- 401
- 404
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
processinginstructioninfo object
attributes object[]
name stringvalue string- taskId integer
- jobIds string[]
{
"processinginstructioninfo": {
"attributes": [
{
"name": "string",
"value": "string"
}
]
},
"taskId": 0,
"jobIds": [
"string"
]
}
{
"processinginstructioninfo": {
"attributes": [
{
"name": "WebServer",
"value": "OBLIVION"
}
]
},
"taskId": 6026,
"jobIds": [
"34350"
]
}
Bad Request
- application/json
- application/xml
- Schema
- Example
Schema
- string
Request body is empty or format is invalid
- Schema
- Example (from schema)
Schema
- object
<root/>
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Access Denied",
"errorCode": 5
}
Not found
- application/json
- Schema
- Example (from schema)
- Example
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "No instance is specified",
"errorCode": 4
}
Loading...