Add HBase App

This API is used to create HBase app data protection

Path Parameters

• instanceid string required

application/json

Request Body

• instanceProperties object required

  Instance Properties

  instance object

  Instance

  instanceId integer

  applicationId integer

  clientId integer
• distributedClusterInstanceProperties object required

  clusterType integer

  Default value: 2

  opType integer

  Default value: 2

  instance object

  instanceId integer

  Instance Id

  instanceName string

  Instance Name

  clusterConfig object

  hadoopConfig object

  Hadoop Configuration

  hadoopApps object

  Hadoop Apps

  appConfigs object

  Apps configuration

  appConfigs object[]

  App configs

  hadoopAppType integer

  Hadoop App Type

  hBaseConfig object

  HBase configurations

  hbaseuser string

  HBase user

  stagingLocation string

  HBase Staging path

  backupRootDir string

Responses

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• processinginstructioninfo object

  attributes object[]

  name string

  value string
• response object

  warningCode integer

  errorCode integer

  warningMessage string

  entity object

  subclientId integer

  clientId integer

  instanceName string

  instanceId integer

  _type_ integer

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "response": {
    "warningCode": 0,
    "errorCode": 0,
    "warningMessage": "string",
    "entity": {
      "subclientId": 0,
      "clientId": 0,
      "instanceName": "string",
      "instanceId": 0,
      "_type_": 0
    }
  }
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "response": {
    "warningCode": 0,
    "errorCode": 0,
    "warningMessage": "",
    "entity": {
      "subclientId": 0,
      "clientId": 0,
      "instanceName": "",
      "instanceId": 0,
      "_type_": 0
    }
  }
}

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": "Access Denied",
  "errorCode": 5
}

POST /instance/:instanceid    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://localhost/commandcenter/api

Security Scheme

tokenbearerToken

token

instanceid — path required

Body

• Default
• Example 1

---

{
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "applicationId": 0,
      "clientId": 0
    }
  },
  "distributedClusterInstanceProperties": {
    "clusterType": 2,
    "opType": 2,
    "instance": {
      "instanceId": 0,
      "instanceName": "string"
    },
    "clusterConfig": {
      "hadoopConfig": {
        "hadoopApps": {
          "appConfigs": {
            "appConfigs": [
              {
                "hadoopAppType": 0,
                "hBaseConfig": {
                  "hbaseuser": "string",
                  "stagingLocation": "string",
                  "backupRootDir": "string"
                }
              }
            ]
          }
        }
      }
    }
  }
}

curl -L -X POST 'https://localhost/commandcenter/api/Instance/:instanceid' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "applicationId": 0,
      "clientId": 0
    }
  },
  "distributedClusterInstanceProperties": {
    "clusterType": 2,
    "opType": 2,
    "instance": {
      "instanceId": 0,
      "instanceName": "string"
    },
    "clusterConfig": {
      "hadoopConfig": {
        "hadoopApps": {
          "appConfigs": {
            "appConfigs": [
              {
                "hadoopAppType": 0,
                "hBaseConfig": {
                  "hbaseuser": "string",
                  "stagingLocation": "string",
                  "backupRootDir": "string"
                }
              }
            ]
          }
        }
      }
    }
  }
}'

curl -L -X POST 'https://localhost/commandcenter/api/Instance/:instanceid' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "applicationId": 0,
      "clientId": 0
    }
  },
  "distributedClusterInstanceProperties": {
    "clusterType": 2,
    "opType": 2,
    "instance": {
      "instanceId": 0,
      "instanceName": "string"
    },
    "clusterConfig": {
      "hadoopConfig": {
        "hadoopApps": {
          "appConfigs": {
            "appConfigs": [
              {
                "hadoopAppType": 0,
                "hBaseConfig": {
                  "hbaseuser": "string",
                  "stagingLocation": "string",
                  "backupRootDir": "string"
                }
              }
            ]
          }
        }
      }
    }
  }
}'

curl -L -X POST 'https://localhost/commandcenter/api/Instance/:instanceid' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "applicationId": 0,
      "clientId": 0
    }
  },
  "distributedClusterInstanceProperties": {
    "clusterType": 2,
    "opType": 2,
    "instance": {
      "instanceId": 0,
      "instanceName": "string"
    },
    "clusterConfig": {
      "hadoopConfig": {
        "hadoopApps": {
          "appConfigs": {
            "appConfigs": [
              {
                "hadoopAppType": 0,
                "hBaseConfig": {
                  "hbaseuser": "string",
                  "stagingLocation": "string",
                  "backupRootDir": "string"
                }
              }
            ]
          }
        }
      }
    }
  }
}'

curl -L -X POST 'https://localhost/commandcenter/api/Instance/:instanceid' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "applicationId": 0,
      "clientId": 0
    }
  },
  "distributedClusterInstanceProperties": {
    "clusterType": 2,
    "opType": 2,
    "instance": {
      "instanceId": 0,
      "instanceName": "string"
    },
    "clusterConfig": {
      "hadoopConfig": {
        "hadoopApps": {
          "appConfigs": {
            "appConfigs": [
              {
                "hadoopAppType": 0,
                "hBaseConfig": {
                  "hbaseuser": "string",
                  "stagingLocation": "string",
                  "backupRootDir": "string"
                }
              }
            ]
          }
        }
      }
    }
  }
}'

curl -L -X POST 'https://localhost/commandcenter/api/Instance/:instanceid' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "applicationId": 0,
      "clientId": 0
    }
  },
  "distributedClusterInstanceProperties": {
    "clusterType": 2,
    "opType": 2,
    "instance": {
      "instanceId": 0,
      "instanceName": "string"
    },
    "clusterConfig": {
      "hadoopConfig": {
        "hadoopApps": {
          "appConfigs": {
            "appConfigs": [
              {
                "hadoopAppType": 0,
                "hBaseConfig": {
                  "hbaseuser": "string",
                  "stagingLocation": "string",
                  "backupRootDir": "string"
                }
              }
            ]
          }
        }
      }
    }
  }
}'

curl -L -X POST 'https://localhost/commandcenter/api/Instance/:instanceid' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "applicationId": 0,
      "clientId": 0
    }
  },
  "distributedClusterInstanceProperties": {
    "clusterType": 2,
    "opType": 2,
    "instance": {
      "instanceId": 0,
      "instanceName": "string"
    },
    "clusterConfig": {
      "hadoopConfig": {
        "hadoopApps": {
          "appConfigs": {
            "appConfigs": [
              {
                "hadoopAppType": 0,
                "hBaseConfig": {
                  "hbaseuser": "string",
                  "stagingLocation": "string",
                  "backupRootDir": "string"
                }
              }
            ]
          }
        }
      }
    }
  }
}'

curl -L -X POST 'https://localhost/commandcenter/api/Instance/:instanceid' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceId": 0,
      "applicationId": 0,
      "clientId": 0
    }
  },
  "distributedClusterInstanceProperties": {
    "clusterType": 2,
    "opType": 2,
    "instance": {
      "instanceId": 0,
      "instanceName": "string"
    },
    "clusterConfig": {
      "hadoopConfig": {
        "hadoopApps": {
          "appConfigs": {
            "appConfigs": [
              {
                "hadoopAppType": 0,
                "hBaseConfig": {
                  "hbaseuser": "string",
                  "stagingLocation": "string",
                  "backupRootDir": "string"
                }
              }
            ]
          }
        }
      }
    }
  }
}'