Restoring a HBase instance

This API is used to restore HBase instance

application/json

Request Body

• taskInfo object

  associations object[]

  subclientId integer

  Subclient Id

  applicationId integer

  Default value: 64

  Application Id

  clientName string

  Hadoop Client NAme

  backupsetId integer

  Backupset Id

  instanceId integer

  Instance Id

  clientId integer

  Client Id

  _type_ integer

  Default value: 7

  task object

  taskType integer

  Default value: 1

  initiatedFrom integer

  Default value: 1

  subTasks object[]

  subTask object

  subTaskType integer

  Default value: 3

  operationType integer

  Default value: 1001

  options object required

  restoreOptions object

  Restore options

  browseOption object

  commCellId integer

  Default value: 2

  Commcell Id

  backupset object

  Source client backupset id

  backupsetId integer

  clientId integer

  timeRange object

  time range

  commonOptions object

  common

  unconditionalOverwrite boolean

  Default value: false

  unconditional overw

  isFromBrowseBackup boolean

  Default value: true

  preserveLevel integer

  Default value: 1

  stripLevelType integer

  overwriteFiles boolean

  overwrite files

  distributedAppsRestoreOptions object required

  distributedRestore boolean

  Default value: true

  isMultiNodeRestore boolean

  Default value: true

  clientType integer

  Default value: 29

  Client Type

  dataAccessNodes object required

  Data Access

  dataAccessNodes object[]

  Data Access Nodes

  hostName string

  Host Name

  clientId integer

  clientName string

  Client Name

  displayName string

  Client display name

  hbaseRestoreOptions object required

  HBase Res

  tableMap object[]

  Source DB, Table to destination DB tb mapping

  fromTable string

  toTable string

  destination object required

  Destination details

  noOfStreams integer

  no of streams

  destClient object

  Destination client

  clientId integer

  clientName string

  destinationInstance object required

  Destination instance details

  clientId integer

  clientName string

  applicationId integer

  appName string

  Default value: Big Data Apps

  instanceId integer

  instanceName string

  fileOption object required

  sourceItem string[]

  qrOption object required

  destAppTypeId integer

  Default value: 64

  commonOpts object

  notifyUserOnJobCompletion boolean

Responses

• 200
• 400
• 401
• 404

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• taskId integer
• jobIds string[]

{
  "taskId": 0,
  "jobIds": [
    "string"
  ]
}

{
  "taskId": 59,
  "jobIds": [
    "33"
  ]
}

Bad Request

application/json

• Schema
• Example 1

---

Schema

• string

Request body is empty or format is invalid

Unauthorized

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "string",
  "errorCode": 0
}

Not Found

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "No instance is specified",
  "errorCode": 4
}

POST /createtask    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://localhost/commandcenter/api

Security Scheme

tokenbearerToken

token

Body

• Default
• Example 1

---

{
  "taskInfo": {
    "associations": [
      {
        "subclientId": 0,
        "applicationId": 64,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "clientId": 0,
        "_type_": 7
      }
    ],
    "task": {
      "taskType": 1,
      "initiatedFrom": 1
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 3,
          "operationType": 1001
        },
        "options": {
          "restoreOptions": {
            "browseOption": {
              "commCellId": 2,
              "backupset": {
                "backupsetId": 0,
                "clientId": 0
              },
              "timeRange": {}
            },
            "commonOptions": {
              "unconditionalOverwrite": false,
              "isFromBrowseBackup": true,
              "preserveLevel": 1,
              "stripLevelType": 0,
              "overwriteFiles": true
            },
            "distributedAppsRestoreOptions": {
              "distributedRestore": true,
              "isMultiNodeRestore": true,
              "clientType": 29,
              "dataAccessNodes": {
                "dataAccessNodes": [
                  {
                    "hostName": "string",
                    "clientId": 0,
                    "clientName": "string",
                    "displayName": "string"
                  }
                ]
              },
              "hbaseRestoreOptions": {
                "tableMap": [
                  {
                    "fromTable": "string",
                    "toTable": "string"
                  }
                ]
              }
            },
            "destination": {
              "noOfStreams": 0,
              "destClient": {
                "clientId": 0,
                "clientName": "string"
              },
              "destinationInstance": {
                "clientId": 0,
                "clientName": "string",
                "applicationId": 0,
                "appName": "Big Data Apps",
                "instanceId": 0,
                "instanceName": "string"
              }
            },
            "fileOption": {
              "sourceItem": [
                "string"
              ]
            },
            "qrOption": {
              "destAppTypeId": 64
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}

curl -L -X POST 'https://localhost/commandcenter/api/Createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "subclientId": 0,
        "applicationId": 64,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "clientId": 0,
        "_type_": 7
      }
    ],
    "task": {
      "taskType": 1,
      "initiatedFrom": 1
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 3,
          "operationType": 1001
        },
        "options": {
          "restoreOptions": {
            "browseOption": {
              "commCellId": 2,
              "backupset": {
                "backupsetId": 0,
                "clientId": 0
              },
              "timeRange": {}
            },
            "commonOptions": {
              "unconditionalOverwrite": false,
              "isFromBrowseBackup": true,
              "preserveLevel": 1,
              "stripLevelType": 0,
              "overwriteFiles": true
            },
            "distributedAppsRestoreOptions": {
              "distributedRestore": true,
              "isMultiNodeRestore": true,
              "clientType": 29,
              "dataAccessNodes": {
                "dataAccessNodes": [
                  {
                    "hostName": "string",
                    "clientId": 0,
                    "clientName": "string",
                    "displayName": "string"
                  }
                ]
              },
              "hbaseRestoreOptions": {
                "tableMap": [
                  {
                    "fromTable": "string",
                    "toTable": "string"
                  }
                ]
              }
            },
            "destination": {
              "noOfStreams": 0,
              "destClient": {
                "clientId": 0,
                "clientName": "string"
              },
              "destinationInstance": {
                "clientId": 0,
                "clientName": "string",
                "applicationId": 0,
                "appName": "Big Data Apps",
                "instanceId": 0,
                "instanceName": "string"
              }
            },
            "fileOption": {
              "sourceItem": [
                "string"
              ]
            },
            "qrOption": {
              "destAppTypeId": 64
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://localhost/commandcenter/api/Createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "subclientId": 0,
        "applicationId": 64,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "clientId": 0,
        "_type_": 7
      }
    ],
    "task": {
      "taskType": 1,
      "initiatedFrom": 1
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 3,
          "operationType": 1001
        },
        "options": {
          "restoreOptions": {
            "browseOption": {
              "commCellId": 2,
              "backupset": {
                "backupsetId": 0,
                "clientId": 0
              },
              "timeRange": {}
            },
            "commonOptions": {
              "unconditionalOverwrite": false,
              "isFromBrowseBackup": true,
              "preserveLevel": 1,
              "stripLevelType": 0,
              "overwriteFiles": true
            },
            "distributedAppsRestoreOptions": {
              "distributedRestore": true,
              "isMultiNodeRestore": true,
              "clientType": 29,
              "dataAccessNodes": {
                "dataAccessNodes": [
                  {
                    "hostName": "string",
                    "clientId": 0,
                    "clientName": "string",
                    "displayName": "string"
                  }
                ]
              },
              "hbaseRestoreOptions": {
                "tableMap": [
                  {
                    "fromTable": "string",
                    "toTable": "string"
                  }
                ]
              }
            },
            "destination": {
              "noOfStreams": 0,
              "destClient": {
                "clientId": 0,
                "clientName": "string"
              },
              "destinationInstance": {
                "clientId": 0,
                "clientName": "string",
                "applicationId": 0,
                "appName": "Big Data Apps",
                "instanceId": 0,
                "instanceName": "string"
              }
            },
            "fileOption": {
              "sourceItem": [
                "string"
              ]
            },
            "qrOption": {
              "destAppTypeId": 64
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://localhost/commandcenter/api/Createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "subclientId": 0,
        "applicationId": 64,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "clientId": 0,
        "_type_": 7
      }
    ],
    "task": {
      "taskType": 1,
      "initiatedFrom": 1
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 3,
          "operationType": 1001
        },
        "options": {
          "restoreOptions": {
            "browseOption": {
              "commCellId": 2,
              "backupset": {
                "backupsetId": 0,
                "clientId": 0
              },
              "timeRange": {}
            },
            "commonOptions": {
              "unconditionalOverwrite": false,
              "isFromBrowseBackup": true,
              "preserveLevel": 1,
              "stripLevelType": 0,
              "overwriteFiles": true
            },
            "distributedAppsRestoreOptions": {
              "distributedRestore": true,
              "isMultiNodeRestore": true,
              "clientType": 29,
              "dataAccessNodes": {
                "dataAccessNodes": [
                  {
                    "hostName": "string",
                    "clientId": 0,
                    "clientName": "string",
                    "displayName": "string"
                  }
                ]
              },
              "hbaseRestoreOptions": {
                "tableMap": [
                  {
                    "fromTable": "string",
                    "toTable": "string"
                  }
                ]
              }
            },
            "destination": {
              "noOfStreams": 0,
              "destClient": {
                "clientId": 0,
                "clientName": "string"
              },
              "destinationInstance": {
                "clientId": 0,
                "clientName": "string",
                "applicationId": 0,
                "appName": "Big Data Apps",
                "instanceId": 0,
                "instanceName": "string"
              }
            },
            "fileOption": {
              "sourceItem": [
                "string"
              ]
            },
            "qrOption": {
              "destAppTypeId": 64
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://localhost/commandcenter/api/Createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "subclientId": 0,
        "applicationId": 64,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "clientId": 0,
        "_type_": 7
      }
    ],
    "task": {
      "taskType": 1,
      "initiatedFrom": 1
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 3,
          "operationType": 1001
        },
        "options": {
          "restoreOptions": {
            "browseOption": {
              "commCellId": 2,
              "backupset": {
                "backupsetId": 0,
                "clientId": 0
              },
              "timeRange": {}
            },
            "commonOptions": {
              "unconditionalOverwrite": false,
              "isFromBrowseBackup": true,
              "preserveLevel": 1,
              "stripLevelType": 0,
              "overwriteFiles": true
            },
            "distributedAppsRestoreOptions": {
              "distributedRestore": true,
              "isMultiNodeRestore": true,
              "clientType": 29,
              "dataAccessNodes": {
                "dataAccessNodes": [
                  {
                    "hostName": "string",
                    "clientId": 0,
                    "clientName": "string",
                    "displayName": "string"
                  }
                ]
              },
              "hbaseRestoreOptions": {
                "tableMap": [
                  {
                    "fromTable": "string",
                    "toTable": "string"
                  }
                ]
              }
            },
            "destination": {
              "noOfStreams": 0,
              "destClient": {
                "clientId": 0,
                "clientName": "string"
              },
              "destinationInstance": {
                "clientId": 0,
                "clientName": "string",
                "applicationId": 0,
                "appName": "Big Data Apps",
                "instanceId": 0,
                "instanceName": "string"
              }
            },
            "fileOption": {
              "sourceItem": [
                "string"
              ]
            },
            "qrOption": {
              "destAppTypeId": 64
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://localhost/commandcenter/api/Createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "subclientId": 0,
        "applicationId": 64,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "clientId": 0,
        "_type_": 7
      }
    ],
    "task": {
      "taskType": 1,
      "initiatedFrom": 1
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 3,
          "operationType": 1001
        },
        "options": {
          "restoreOptions": {
            "browseOption": {
              "commCellId": 2,
              "backupset": {
                "backupsetId": 0,
                "clientId": 0
              },
              "timeRange": {}
            },
            "commonOptions": {
              "unconditionalOverwrite": false,
              "isFromBrowseBackup": true,
              "preserveLevel": 1,
              "stripLevelType": 0,
              "overwriteFiles": true
            },
            "distributedAppsRestoreOptions": {
              "distributedRestore": true,
              "isMultiNodeRestore": true,
              "clientType": 29,
              "dataAccessNodes": {
                "dataAccessNodes": [
                  {
                    "hostName": "string",
                    "clientId": 0,
                    "clientName": "string",
                    "displayName": "string"
                  }
                ]
              },
              "hbaseRestoreOptions": {
                "tableMap": [
                  {
                    "fromTable": "string",
                    "toTable": "string"
                  }
                ]
              }
            },
            "destination": {
              "noOfStreams": 0,
              "destClient": {
                "clientId": 0,
                "clientName": "string"
              },
              "destinationInstance": {
                "clientId": 0,
                "clientName": "string",
                "applicationId": 0,
                "appName": "Big Data Apps",
                "instanceId": 0,
                "instanceName": "string"
              }
            },
            "fileOption": {
              "sourceItem": [
                "string"
              ]
            },
            "qrOption": {
              "destAppTypeId": 64
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://localhost/commandcenter/api/Createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "subclientId": 0,
        "applicationId": 64,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "clientId": 0,
        "_type_": 7
      }
    ],
    "task": {
      "taskType": 1,
      "initiatedFrom": 1
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 3,
          "operationType": 1001
        },
        "options": {
          "restoreOptions": {
            "browseOption": {
              "commCellId": 2,
              "backupset": {
                "backupsetId": 0,
                "clientId": 0
              },
              "timeRange": {}
            },
            "commonOptions": {
              "unconditionalOverwrite": false,
              "isFromBrowseBackup": true,
              "preserveLevel": 1,
              "stripLevelType": 0,
              "overwriteFiles": true
            },
            "distributedAppsRestoreOptions": {
              "distributedRestore": true,
              "isMultiNodeRestore": true,
              "clientType": 29,
              "dataAccessNodes": {
                "dataAccessNodes": [
                  {
                    "hostName": "string",
                    "clientId": 0,
                    "clientName": "string",
                    "displayName": "string"
                  }
                ]
              },
              "hbaseRestoreOptions": {
                "tableMap": [
                  {
                    "fromTable": "string",
                    "toTable": "string"
                  }
                ]
              }
            },
            "destination": {
              "noOfStreams": 0,
              "destClient": {
                "clientId": 0,
                "clientName": "string"
              },
              "destinationInstance": {
                "clientId": 0,
                "clientName": "string",
                "applicationId": 0,
                "appName": "Big Data Apps",
                "instanceId": 0,
                "instanceName": "string"
              }
            },
            "fileOption": {
              "sourceItem": [
                "string"
              ]
            },
            "qrOption": {
              "destAppTypeId": 64
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'

curl -L -X POST 'https://localhost/commandcenter/api/Createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "subclientId": 0,
        "applicationId": 64,
        "clientName": "string",
        "backupsetId": 0,
        "instanceId": 0,
        "clientId": 0,
        "_type_": 7
      }
    ],
    "task": {
      "taskType": 1,
      "initiatedFrom": 1
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 3,
          "operationType": 1001
        },
        "options": {
          "restoreOptions": {
            "browseOption": {
              "commCellId": 2,
              "backupset": {
                "backupsetId": 0,
                "clientId": 0
              },
              "timeRange": {}
            },
            "commonOptions": {
              "unconditionalOverwrite": false,
              "isFromBrowseBackup": true,
              "preserveLevel": 1,
              "stripLevelType": 0,
              "overwriteFiles": true
            },
            "distributedAppsRestoreOptions": {
              "distributedRestore": true,
              "isMultiNodeRestore": true,
              "clientType": 29,
              "dataAccessNodes": {
                "dataAccessNodes": [
                  {
                    "hostName": "string",
                    "clientId": 0,
                    "clientName": "string",
                    "displayName": "string"
                  }
                ]
              },
              "hbaseRestoreOptions": {
                "tableMap": [
                  {
                    "fromTable": "string",
                    "toTable": "string"
                  }
                ]
              }
            },
            "destination": {
              "noOfStreams": 0,
              "destClient": {
                "clientId": 0,
                "clientName": "string"
              },
              "destinationInstance": {
                "clientId": 0,
                "clientName": "string",
                "applicationId": 0,
                "appName": "Big Data Apps",
                "instanceId": 0,
                "instanceName": "string"
              }
            },
            "fileOption": {
              "sourceItem": [
                "string"
              ]
            },
            "qrOption": {
              "destAppTypeId": 64
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true
          }
        }
      }
    ]
  }
}'