Skip to main content

Restore a COSMOS DB Cassandra API instance​

This API is used to restore Azure Cosmos DB Cassandra API instance

Request Body
  • taskInfo object
  • associations object[]
  • timezone object
  • clientId integer
  • instanceName string
  • client object
  • owner object
  • subclientId integer
  • applicationId integer
  • appName string
  • clientName string
  • backupsetId integer
  • instanceId integer
  • subtask object
  • backupsetName string
  • _type_ string
  • task object
  • taskType string
  • initiatedFrom string
  • policyType string
  • subTasks object[]
  • subTask object
  • subTaskType string
  • operationType string
  • options object
  • restoreOptions object
  • browseOption object
  • commCellId integer
  • timeRange object
  • fromTime integer
  • toTime integer
  • destination object
  • noOfStreams integer
  • destClient object
  • clientId integer
  • clientName string
  • destinationInstance object
  • clientId integer
  • clientName string
  • applicationId integer
  • appName string
  • instanceId integer
  • instanceName string
  • fileOption object
  • sourceItem string[]
  • cloudAppsRestoreOptions object
  • instanceType string
  • azureDbRestoreOptions object
  • overwrite boolean
  • restoreEntity object[]
  • srcEntity object
  • storageAccountName string
  • tableName string
  • databaseName string
  • destEntity object
  • storageAccountName string
  • tableName string
  • databaseName string
  • commonOpts object
  • subscriptionInfo string
  • 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": [

      {

        "timezone": {},

        "clientId": 0,

        "instanceName": "string",

        "client": {},

        "owner": {},

        "subclientId": 0,

        "applicationId": 0,

        "appName": "string",

        "clientName": "string",

        "backupsetId": 0,

        "instanceId": 0,

        "subtask": {},

        "backupsetName": "string",

        "_type_": "string"

      }

    ],

    "task": {

      "taskType": "string",

      "initiatedFrom": "string",

      "policyType": "string"

    },

    "subTasks": [

      {

        "subTask": {

          "subTaskType": "string",

          "operationType": "string"

        },

        "options": {

          "restoreOptions": {

            "browseOption": {

              "commCellId": 0,

              "timeRange": {

                "fromTime": 0,

                "toTime": 0

              }

            },

            "destination": {

              "noOfStreams": 0,

              "destClient": {

                "clientId": 0,

                "clientName": "string"

              },

              "destinationInstance": {

                "clientId": 0,

                "clientName": "string",

                "applicationId": 0,

                "appName": "string",

                "instanceId": 0,

                "instanceName": "string"

              }

            },

            "fileOption": {

              "sourceItem": [

                "string"

              ]

            },

            "cloudAppsRestoreOptions": {

              "instanceType": "string",

              "azureDbRestoreOptions": {

                "overwrite": true,

                "restoreEntity": [

                  {

                    "srcEntity": {

                      "storageAccountName": "string",

                      "tableName": "string",

                      "databaseName": "string"

                    },

                    "destEntity": {

                      "storageAccountName": "string",

                      "tableName": "string",

                      "databaseName": "string"

                    }

                  }

                ]

              }

            }

          },

          "commonOpts": {

            "subscriptionInfo": "string",

            "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": [
      {
        "timezone": {},
        "clientId": 0,
        "instanceName": "string",
        "client": {},
        "owner": {},
        "subclientId": 0,
        "applicationId": 0,
        "appName": "string",
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "subtask": {},
        "backupsetName": "string",
        "_type_": "string"
      }
    ],
    "task": {
      "taskType": "string",
      "initiatedFrom": "string",
      "policyType": "string"
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": "string",
          "operationType": "string"
        },
        "options": {
          "restoreOptions": {
            "browseOption": {
              "commCellId": 0,
              "timeRange": {
                "fromTime": 0,
                "toTime": 0
              }
            },
            "destination": {
              "noOfStreams": 0,
              "destClient": {
                "clientId": 0,
                "clientName": "string"
              },
              "destinationInstance": {
                "clientId": 0,
                "clientName": "string",
                "applicationId": 0,
                "appName": "string",
                "instanceId": 0,
                "instanceName": "string"
              }
            },
            "fileOption": {
              "sourceItem": [
                "string"
              ]
            },
            "cloudAppsRestoreOptions": {
              "instanceType": "string",
              "azureDbRestoreOptions": {
                "overwrite": true,
                "restoreEntity": [
                  {
                    "srcEntity": {
                      "storageAccountName": "string",
                      "tableName": "string",
                      "databaseName": "string"
                    },
                    "destEntity": {
                      "storageAccountName": "string",
                      "tableName": "string",
                      "databaseName": "string"
                    }
                  }
                ]
              }
            }
          },
          "commonOpts": {
            "subscriptionInfo": "string",
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'