AWS DocumentDB cluster backup
This operation starts a backup job of DocumentDB
- application/json
Request Body
taskInfo object
Responses
- 200
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- taskId integer
- jobIds string[]
{
"taskId": 0,
"jobIds": [
"string"
]
}
{
"taskId": 0,
"jobIds": [
"string"
]
}
POST /createtask
Authorization
type: apiKeyname: Authtokenin: header
Request
Request
curl -L -X POST 'https://ServerURL/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",
"backupsetId": 0,
"_type_": 0,
"commCellName": "string",
"instanceId": 0,
"subclientId": 0,
"clientId": 0,
"appName": "string",
"backupsetName": "defaultBackupSet",
"applicationId": 0,
"subclientName": "string",
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
}
}
],
"task": {
"taskType": 0
},
"subTasks": [
{
"subTask": {
"subTaskType": 0,
"operationType": 0
},
"options": {
"backupOpts": {
"backupLevel": "FULL"
},
"commonOpts": {
"notifyUserOnJobCompletion": true
},
"adminOpts": {
"clientInstallOption": {
"installerOption": {
"User": {
"userId": 0,
"userName": "string"
}
}
}
}
}
}
]
}
}'
curl -L -X POST 'https://ServerURL/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",
"backupsetId": 0,
"_type_": 0,
"commCellName": "string",
"instanceId": 0,
"subclientId": 0,
"clientId": 0,
"appName": "string",
"backupsetName": "defaultBackupSet",
"applicationId": 0,
"subclientName": "string",
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
}
}
],
"task": {
"taskType": 0
},
"subTasks": [
{
"subTask": {
"subTaskType": 0,
"operationType": 0
},
"options": {
"backupOpts": {
"backupLevel": "FULL"
},
"commonOpts": {
"notifyUserOnJobCompletion": true
},
"adminOpts": {
"clientInstallOption": {
"installerOption": {
"User": {
"userId": 0,
"userName": "string"
}
}
}
}
}
}
]
}
}'
curl -L -X POST 'https://ServerURL/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",
"backupsetId": 0,
"_type_": 0,
"commCellName": "string",
"instanceId": 0,
"subclientId": 0,
"clientId": 0,
"appName": "string",
"backupsetName": "defaultBackupSet",
"applicationId": 0,
"subclientName": "string",
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
}
}
],
"task": {
"taskType": 0
},
"subTasks": [
{
"subTask": {
"subTaskType": 0,
"operationType": 0
},
"options": {
"backupOpts": {
"backupLevel": "FULL"
},
"commonOpts": {
"notifyUserOnJobCompletion": true
},
"adminOpts": {
"clientInstallOption": {
"installerOption": {
"User": {
"userId": 0,
"userName": "string"
}
}
}
}
}
}
]
}
}'
curl -L -X POST 'https://ServerURL/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",
"backupsetId": 0,
"_type_": 0,
"commCellName": "string",
"instanceId": 0,
"subclientId": 0,
"clientId": 0,
"appName": "string",
"backupsetName": "defaultBackupSet",
"applicationId": 0,
"subclientName": "string",
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
}
}
],
"task": {
"taskType": 0
},
"subTasks": [
{
"subTask": {
"subTaskType": 0,
"operationType": 0
},
"options": {
"backupOpts": {
"backupLevel": "FULL"
},
"commonOpts": {
"notifyUserOnJobCompletion": true
},
"adminOpts": {
"clientInstallOption": {
"installerOption": {
"User": {
"userId": 0,
"userName": "string"
}
}
}
}
}
}
]
}
}'
curl -L -X POST 'https://ServerURL/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",
"backupsetId": 0,
"_type_": 0,
"commCellName": "string",
"instanceId": 0,
"subclientId": 0,
"clientId": 0,
"appName": "string",
"backupsetName": "defaultBackupSet",
"applicationId": 0,
"subclientName": "string",
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
}
}
],
"task": {
"taskType": 0
},
"subTasks": [
{
"subTask": {
"subTaskType": 0,
"operationType": 0
},
"options": {
"backupOpts": {
"backupLevel": "FULL"
},
"commonOpts": {
"notifyUserOnJobCompletion": true
},
"adminOpts": {
"clientInstallOption": {
"installerOption": {
"User": {
"userId": 0,
"userName": "string"
}
}
}
}
}
}
]
}
}'
curl -L -X POST 'https://ServerURL/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",
"backupsetId": 0,
"_type_": 0,
"commCellName": "string",
"instanceId": 0,
"subclientId": 0,
"clientId": 0,
"appName": "string",
"backupsetName": "defaultBackupSet",
"applicationId": 0,
"subclientName": "string",
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
}
}
],
"task": {
"taskType": 0
},
"subTasks": [
{
"subTask": {
"subTaskType": 0,
"operationType": 0
},
"options": {
"backupOpts": {
"backupLevel": "FULL"
},
"commonOpts": {
"notifyUserOnJobCompletion": true
},
"adminOpts": {
"clientInstallOption": {
"installerOption": {
"User": {
"userId": 0,
"userName": "string"
}
}
}
}
}
}
]
}
}'
curl -L -X POST 'https://ServerURL/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",
"backupsetId": 0,
"_type_": 0,
"commCellName": "string",
"instanceId": 0,
"subclientId": 0,
"clientId": 0,
"appName": "string",
"backupsetName": "defaultBackupSet",
"applicationId": 0,
"subclientName": "string",
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
}
}
],
"task": {
"taskType": 0
},
"subTasks": [
{
"subTask": {
"subTaskType": 0,
"operationType": 0
},
"options": {
"backupOpts": {
"backupLevel": "FULL"
},
"commonOpts": {
"notifyUserOnJobCompletion": true
},
"adminOpts": {
"clientInstallOption": {
"installerOption": {
"User": {
"userId": 0,
"userName": "string"
}
}
}
}
}
}
]
}
}'