Skip to main content

AWS DocumentDB restore​

Select

SaaS
Customer Managed

This operation performs restore for DocumentDB

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

    Name of cl

  • instanceName string

    Name of instance

  • displayName string
  • backupsetId integer
  • _type_ string
  • commCellName string
  • instanceId integer
  • subclientId integer
  • clientId integer
  • appName string
  • backupsetName string

    Default value: defaultBackupSet

  • applicationId integer
  • subclientName string

    Name of cluster group

  • entityInfo object
  • companyId integer
  • companyName string

    Default value: Commcell

  • multiCommcellId integer
  • cloudInstanceType string

    Default value: AMAZON_DOCUMENTDB

  • entityName string
  • task object
  • taskType integer
  • initiatedFrom integer
  • subTasks object[] required
  • subTask object
  • subTaskType integer
  • operationType integer
  • options object
  • restoreOptions object
  • browseOption object
  • commCellId integer
  • timeRange object
  • fromTime integer

    Time stamp from which to look for cluster to restore

  • toTime integer
  • destination object
  • destClient object required
  • clientId integer
  • clientName string
  • destinationInstance object
  • clientName string
  • instanceName string
  • displayName string
  • backupsetId integer
  • _type_ string
  • commCellName string
  • instanceId integer
  • csGUID string
  • subclientGUID string
  • subclientId integer
  • clientId integer
  • appName string
  • backupsetName string
  • applicationId integer
  • subclientName string
  • entityInfo object
  • companyId integer
  • companyName string
  • multiCommcellId integer
  • cloudInstanceType string
  • entityName string
  • oracleOpt object
  • fileOption object required
  • sourceItem string[]

    The snapshot to be restored

  • commonOptions object
  • jobIds object[]
  • cloudAppsRestoreOptions object
  • instanceType integer
  • redshiftRestoreOption object
  • availabilityZone string
  • publicallyAccessible boolean
  • targetSubnetGroup string
  • allowVersionUpgrade boolean
  • restoreSnapshotId string
  • 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://ServerURL/commandcenter/api
Security Scheme
token
Body
{

  "taskInfo": {

    "associations": [

      {

        "clientName": "string",

        "instanceName": "string",

        "displayName": "string",

        "backupsetId": 0,

        "_type_": "string",

        "commCellName": "string",

        "instanceId": 0,

        "subclientId": 0,

        "clientId": 0,

        "appName": "string",

        "backupsetName": "defaultBackupSet",

        "applicationId": 0,

        "subclientName": "string",

        "entityInfo": {

          "companyId": 0,

          "companyName": "Commcell",

          "multiCommcellId": 0

        },

        "cloudInstanceType": "AMAZON_DOCUMENTDB",

        "entityName": "string"

      }

    ],

    "task": {

      "taskType": 0,

      "initiatedFrom": 0

    },

    "subTasks": [

      {

        "subTask": {

          "subTaskType": 0,

          "operationType": 0

        },

        "options": {

          "restoreOptions": {

            "browseOption": {

              "commCellId": 0,

              "timeRange": {

                "fromTime": 0,

                "toTime": 0

              }

            },

            "destination": {

              "destClient": {

                "clientId": 0,

                "clientName": "string"

              },

              "destinationInstance": {

                "clientName": "string",

                "instanceName": "string",

                "displayName": "string",

                "backupsetId": 0,

                "_type_": "string",

                "commCellName": "string",

                "instanceId": 0,

                "csGUID": "string",

                "subclientGUID": "string",

                "subclientId": 0,

                "clientId": 0,

                "appName": "string",

                "backupsetName": "string",

                "applicationId": 0,

                "subclientName": "string",

                "entityInfo": {

                  "companyId": 0,

                  "companyName": "string",

                  "multiCommcellId": 0

                },

                "cloudInstanceType": "string",

                "entityName": "string"

              }

            },

            "oracleOpt": {},

            "fileOption": {

              "sourceItem": [

                "string"

              ]

            },

            "commonOptions": {},

            "jobIds": [

              {}

            ],

            "cloudAppsRestoreOptions": {

              "instanceType": 0,

              "redshiftRestoreOption": {

                "availabilityZone": "string",

                "publicallyAccessible": true,

                "targetSubnetGroup": "string",

                "allowVersionUpgrade": true,

                "restoreSnapshotId": "string"

              }

            }

          },

          "commonOpts": {

            "notifyUserOnJobCompletion": true,

            "prePostOpts": {

              "preRecoveryCommand": "string",

              "postRecoveryCommand": "string",

              "runPostWhenFail": true

            }

          }

        }

      }

    ]

  }

}

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_": "string",
        "commCellName": "string",
        "instanceId": 0,
        "subclientId": 0,
        "clientId": 0,
        "appName": "string",
        "backupsetName": "defaultBackupSet",
        "applicationId": 0,
        "subclientName": "string",
        "entityInfo": {
          "companyId": 0,
          "companyName": "Commcell",
          "multiCommcellId": 0
        },
        "cloudInstanceType": "AMAZON_DOCUMENTDB",
        "entityName": "string"
      }
    ],
    "task": {
      "taskType": 0,
      "initiatedFrom": 0
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "restoreOptions": {
            "browseOption": {
              "commCellId": 0,
              "timeRange": {
                "fromTime": 0,
                "toTime": 0
              }
            },
            "destination": {
              "destClient": {
                "clientId": 0,
                "clientName": "string"
              },
              "destinationInstance": {
                "clientName": "string",
                "instanceName": "string",
                "displayName": "string",
                "backupsetId": 0,
                "_type_": "string",
                "commCellName": "string",
                "instanceId": 0,
                "csGUID": "string",
                "subclientGUID": "string",
                "subclientId": 0,
                "clientId": 0,
                "appName": "string",
                "backupsetName": "string",
                "applicationId": 0,
                "subclientName": "string",
                "entityInfo": {
                  "companyId": 0,
                  "companyName": "string",
                  "multiCommcellId": 0
                },
                "cloudInstanceType": "string",
                "entityName": "string"
              }
            },
            "oracleOpt": {},
            "fileOption": {
              "sourceItem": [
                "string"
              ]
            },
            "commonOptions": {},
            "jobIds": [
              {}
            ],
            "cloudAppsRestoreOptions": {
              "instanceType": 0,
              "redshiftRestoreOption": {
                "availabilityZone": "string",
                "publicallyAccessible": true,
                "targetSubnetGroup": "string",
                "allowVersionUpgrade": true,
                "restoreSnapshotId": "string"
              }
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true,
            "prePostOpts": {
              "preRecoveryCommand": "string",
              "postRecoveryCommand": "string",
              "runPostWhenFail": true
            }
          }
        }
      }
    ]
  }
}'