Skip to main content

Restoring a couchbase instance​

Select

SaaS
Customer Managed

This API is used to restore couchbase instance

Request Body
  • taskInfo object
  • associations object[] required

    Subclient Info

  • applicationId integer

    Internal field

  • clientName string

    Clientname of the couchbase instance

  • backupsetId integer

    Backup set ID

  • instanceId integer

    Couchbase instance ID

  • clientId integer
  • task object required

    Restore

  • taskType integer

    Default value: 1

    default

  • initiatedFrom integer

    Default value: 1

    Default value 1

  • subTasks object[] required
  • subTask object

    Defaults

  • subTaskType integer

    Default value: 3

  • operationType integer

    Default value: 1001

  • options object required
  • restoreOptions object
  • browseOption object
  • commCellId integer

    Default value: 2

    Default 2

  • backupset object

    Backupset details

  • backupsetId integer

    Source client backupset id

  • clientId integer

    Client ID of the source instace

  • timeRange object
  • commonOptions object

    Internal fields

  • unconditionalOverwrite boolean
  • isFromBrowseBackup boolean

    Default value: true

  • preserveLevel integer

    Default value: 1

  • stripLevelType integer
  • overwriteFiles boolean
  • distributedAppsRestoreOptions object required
  • distributedRestore boolean

    Default value: true

    Internal field

  • isMultiNodeRestore boolean

    Default value: true

    Internal field

  • clientType integer

    Default value: 29

    Internal field

  • dataAccessNodes object required

    Couchbase nodes

  • dataAccessNodes object[] required

    List of access node for couchbase

  • hostName string

    Hostname of the accessnode

  • clientId integer

    client Id of the access node

  • clientName string

    client name of the access node

  • stageFreeRestoreOptions object
  • restoreItems object[] required

    List of buckets to restore. Get this from browse

  • srcEntityName string

    Source bucket name

  • destEntityName string

    Destination bucket name. Use same for inplace restore

  • destination object required
  • noOfStreams integer
  • destClient object required

    Destination cluster details

  • clientId integer

    Destination client ID

  • clientName string
  • destinationInstance object required

    Destination co instance details

  • clientId integer

    Client id of the

  • clientName string

    client name of the instance (instance name)

  • applicationId integer

    Default value: 64

    Default value

  • appName string

    Big Data Apps

  • instanceId integer

    Instance ID of the destination

  • instanceName string

    Instance name

  • fileOption object required
  • sourceItem string[] required

    List of buckets selected for estore

  • qrOption object

    Internal field

  • destAppTypeId integer

    Default value: 64

  • commonOpts object
  • notifyUserOnJobCompletion boolean
Responses

OK

Schema
  • taskId integer
  • jobIds string[]
Loading...