Skip to main content

Restore a cassandra instance​

This API is used to restore cassandra instance

Request Body
  • taskInfo object
  • associations object[]
  • subclientId integer
  • applicationId integer
  • appName string
  • clientName string
  • instanceName string
  • backupsetId integer
  • instanceId integer
  • clientId integer
  • _type_ string
  • task object
  • taskType integer
  • initiatedFrom integer
  • subTasks object[]
  • subTask object
  • subTaskType string
  • operationType string
  • options object
  • restoreOptions object
  • browseOption object
  • commCellId integer
  • backupset object
  • backupsetId integer
  • clientId integer
  • timeRange object
  • destination object
  • noOfStreams integer
  • destClient object
  • clientId integer
  • clientName string
  • destinationInstance object
  • clientId integer
  • clientName string
  • applicationId integer
  • appName string
  • instanceId integer
  • instanceName string
  • distributedAppsRestoreOptions object
  • distributedRestore boolean
  • cassandraRestoreOptions object
  • outofPlaceRestore boolean
  • replaceDeadNode boolean
  • recover boolean
  • stagingLocation string
  • useSSTableLoader boolean
  • runLogRestore boolean
  • runStageFreeRestore boolean
  • DBRestore boolean
  • truncateTables boolean
  • fileOption object
  • sourceItem string[]
  • qrOption object
  • destAppTypeId integer
  • commonOpts object
  • notifyUserOnJobCompletion boolean
Responses

OK

Schema
  • 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": {

    "associations": [

      {

        "subclientId": 0,

        "applicationId": 0,

        "appName": "string",

        "clientName": "string",

        "instanceName": "string",

        "backupsetId": 0,

        "instanceId": 0,

        "clientId": 0,

        "_type_": "string"

      }

    ],

    "task": {

      "taskType": 0,

      "initiatedFrom": 0

    },

    "subTasks": [

      {

        "subTask": {

          "subTaskType": "string",

          "operationType": "string"

        },

        "options": {

          "restoreOptions": {

            "browseOption": {

              "commCellId": 0,

              "backupset": {

                "backupsetId": 0,

                "clientId": 0

              },

              "timeRange": {}

            },

            "destination": {

              "noOfStreams": 0,

              "destClient": {

                "clientId": 0,

                "clientName": "string"

              },

              "destinationInstance": {

                "clientId": 0,

                "clientName": "string",

                "applicationId": 0,

                "appName": "string",

                "instanceId": 0,

                "instanceName": "string"

              }

            },

            "distributedAppsRestoreOptions": {

              "distributedRestore": true,

              "cassandraRestoreOptions": {

                "outofPlaceRestore": true,

                "replaceDeadNode": true,

                "recover": true,

                "stagingLocation": "string",

                "useSSTableLoader": true,

                "runLogRestore": true,

                "runStageFreeRestore": true,

                "DBRestore": true,

                "truncateTables": true

              }

            },

            "fileOption": {

              "sourceItem": [

                "string"

              ]

            },

            "qrOption": {

              "destAppTypeId": 0

            }

          },

          "commonOpts": {

            "notifyUserOnJobCompletion": 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": {
    "associations": [
      {
        "subclientId": 0,
        "applicationId": 0,
        "appName": "string",
        "clientName": "string",
        "instanceName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "clientId": 0,
        "_type_": "string"
      }
    ],
    "task": {
      "taskType": 0,
      "initiatedFrom": 0
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "string",
          "operationType": "string"
        },
        "options": {
          "restoreOptions": {
            "browseOption": {
              "commCellId": 0,
              "backupset": {
                "backupsetId": 0,
                "clientId": 0
              },
              "timeRange": {}
            },
            "destination": {
              "noOfStreams": 0,
              "destClient": {
                "clientId": 0,
                "clientName": "string"
              },
              "destinationInstance": {
                "clientId": 0,
                "clientName": "string",
                "applicationId": 0,
                "appName": "string",
                "instanceId": 0,
                "instanceName": "string"
              }
            },
            "distributedAppsRestoreOptions": {
              "distributedRestore": true,
              "cassandraRestoreOptions": {
                "outofPlaceRestore": true,
                "replaceDeadNode": true,
                "recover": true,
                "stagingLocation": "string",
                "useSSTableLoader": true,
                "runLogRestore": true,
                "runStageFreeRestore": true,
                "DBRestore": true,
                "truncateTables": true
              }
            },
            "fileOption": {
              "sourceItem": [
                "string"
              ]
            },
            "qrOption": {
              "destAppTypeId": 0
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'