Skip to main content

Create Hadoop Instance​

This API is used to create a hadoop instance/pseudoclient

Request Body
  • createPseudoClientRequest object
  • clientInfo object
  • clientType integer
  • plan object

    Specify plan id or name

  • planId integer

    Plan Id

  • optionText object
  • key
  • ref
  • props object
  • isMultiple boolean
  • planEntity object
  • numCopies integer
  • type string
  • subtype string
  • numAssocEntities integer
  • rpoInMinutes integer
  • parent object
  • storage object
  • copy object[]
  • copyType string
  • active string
  • isDefault string
  • isSnapCopy string
  • isMirrorCopy string
  • wormStorageFlag integer
  • poolRetentionPeriodDays integer
  • copyPrecedence integer
  • storagePoolType string
  • storageType integer
  • dedupeFlags object
  • retentionRules object
  • retainBackupDataForCycles integer
  • jobs integer
  • retainArchiverDataForDays integer
  • retainBackupDataForDays integer
  • retentionFlags object
  • enableDataAging string
  • jobBasedRetention string
  • StoragePolicyCopy object
  • copyId integer
  • copyName string
  • extendedFlags object
  • overRideGACPRetention string
  • useGlobalStoragePolicy string
  • drivePool object
  • drivePoolName string
  • drivePoolId integer
  • copyFlags object
  • library object
  • libraryName string
  • libraryId integer
  • startTime object
  • time integer
  • useGlobalPolicy object
  • storagePolicyName string
  • storagePolicyId integer
  • plan object
  • planSummary string
  • planName string
  • planId integer
  • entityInfo object
  • companyId integer
  • companyName string
  • multiCommcellId integer
  • RPOHours string
  • NumberOfCopies string
  • PrimaryStorageRetention string
  • PrimaryStorageType string
  • AssociatedEntitiesCount string
  • _owner
  • planName string

    Plan name

  • type string
  • selected boolean
  • subclientInfo object
  • useLocalContent boolean

    Flag to use local backup content than plan

  • contentOperationType integer
  • content object[]
  • path string

    HBase Databases or Tables. Default all databases

  • fsSubClientProp object
  • useGlobalFilters string

    Default value: USE_CELL_LEVEL_POLICY

  • distributedClusterInstanceProperties object
  • clusterType integer

    Default value: 2

  • opType integer

    Default value: 2

  • instance object
  • instanceId integer
  • instanceName string required

    Name of the Hadoop pseudoclient

  • clientName string required
  • applicationId integer required

    Default value: 64

  • clusterConfig object
  • hadoopConfig object
  • coordinatorNode object required

    Master or Coordinator node

  • hostName string required

    Host name

  • clientId integer required
  • clientName string required
  • displayName string required
  • selected boolean required
  • hadoopSites object
  • hadoopSites object[]
  • hdfsHost string required
  • hdfsUser string required

    User who has access to HDFS

  • dataAccessNodes object

    Data Access nodes

  • dataAccessNodes object[]
  • hostName string required

    Host name

  • clientId integer required
  • clientName string required

    Data Access Client Name

  • displayName string
  • selected boolean
  • entity object
  • clientName string
Responses

OK

Schema
  • processinginstructioninfo object
  • attributes object[]
  • name string
  • value string
  • response object
  • errorCode integer
  • entity object
  • clientId integer
  • clientName string
  • instanceId integer
  • _type_ integer
POST /client/hadoop

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://localhost/commandcenter/api
Security Scheme
token
Body
{

  "createPseudoClientRequest": {

    "clientInfo": {

      "clientType": 0,

      "plan": {

        "planId": 0,

        "optionText": {

          "props": {

            "isMultiple": true,

            "planEntity": {

              "numCopies": 0,

              "type": "string",

              "subtype": "string",

              "numAssocEntities": 0,

              "rpoInMinutes": 0,

              "parent": {},

              "storage": {

                "copy": [

                  {

                    "copyType": "string",

                    "active": "string",

                    "isDefault": "string",

                    "isSnapCopy": "string",

                    "isMirrorCopy": "string",

                    "wormStorageFlag": 0,

                    "poolRetentionPeriodDays": 0,

                    "copyPrecedence": 0,

                    "storagePoolType": "string",

                    "storageType": 0,

                    "dedupeFlags": {},

                    "retentionRules": {

                      "retainBackupDataForCycles": 0,

                      "jobs": 0,

                      "retainArchiverDataForDays": 0,

                      "retainBackupDataForDays": 0,

                      "retentionFlags": {

                        "enableDataAging": "string",

                        "jobBasedRetention": "string"

                      }

                    },

                    "StoragePolicyCopy": {

                      "copyId": 0,

                      "copyName": "string"

                    },

                    "extendedFlags": {

                      "overRideGACPRetention": "string",

                      "useGlobalStoragePolicy": "string"

                    },

                    "drivePool": {

                      "drivePoolName": "string",

                      "drivePoolId": 0

                    },

                    "copyFlags": {},

                    "library": {

                      "libraryName": "string",

                      "libraryId": 0

                    },

                    "startTime": {

                      "time": 0

                    },

                    "useGlobalPolicy": {

                      "storagePolicyName": "string",

                      "storagePolicyId": 0

                    }

                  }

                ]

              },

              "plan": {

                "planSummary": "string",

                "planName": "string",

                "planId": 0,

                "entityInfo": {

                  "companyId": 0,

                  "companyName": "string",

                  "multiCommcellId": 0

                }

              },

              "RPOHours": "string",

              "NumberOfCopies": "string",

              "PrimaryStorageRetention": "string",

              "PrimaryStorageType": "string",

              "AssociatedEntitiesCount": "string"

            }

          }

        },

        "planName": "string",

        "type": "string",

        "selected": true

      },

      "subclientInfo": {

        "useLocalContent": true,

        "contentOperationType": 0,

        "content": [

          {

            "path": "string"

          }

        ],

        "fsSubClientProp": {

          "useGlobalFilters": "USE_CELL_LEVEL_POLICY"

        }

      },

      "distributedClusterInstanceProperties": {

        "clusterType": 2,

        "opType": 2,

        "instance": {

          "instanceId": 0,

          "instanceName": "string",

          "clientName": "string",

          "applicationId": 64

        },

        "clusterConfig": {

          "hadoopConfig": {

            "coordinatorNode": {

              "hostName": "string",

              "clientId": 0,

              "clientName": "string",

              "displayName": "string",

              "selected": true

            },

            "hadoopSites": {

              "hadoopSites": [

                {

                  "hdfsHost": "string",

                  "hdfsUser": "string"

                }

              ]

            }

          }

        },

        "dataAccessNodes": {

          "dataAccessNodes": [

            {

              "hostName": "string",

              "clientId": 0,

              "clientName": "string",

              "displayName": "string",

              "selected": true

            }

          ]

        }

      }

    },

    "entity": {

      "clientName": "string"

    }

  }

}

curl -L -X POST 'https://localhost/commandcenter/api/Client/Hadoop' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "createPseudoClientRequest": {
    "clientInfo": {
      "clientType": 0,
      "plan": {
        "planId": 0,
        "optionText": {
          "props": {
            "isMultiple": true,
            "planEntity": {
              "numCopies": 0,
              "type": "string",
              "subtype": "string",
              "numAssocEntities": 0,
              "rpoInMinutes": 0,
              "parent": {},
              "storage": {
                "copy": [
                  {
                    "copyType": "string",
                    "active": "string",
                    "isDefault": "string",
                    "isSnapCopy": "string",
                    "isMirrorCopy": "string",
                    "wormStorageFlag": 0,
                    "poolRetentionPeriodDays": 0,
                    "copyPrecedence": 0,
                    "storagePoolType": "string",
                    "storageType": 0,
                    "dedupeFlags": {},
                    "retentionRules": {
                      "retainBackupDataForCycles": 0,
                      "jobs": 0,
                      "retainArchiverDataForDays": 0,
                      "retainBackupDataForDays": 0,
                      "retentionFlags": {
                        "enableDataAging": "string",
                        "jobBasedRetention": "string"
                      }
                    },
                    "StoragePolicyCopy": {
                      "copyId": 0,
                      "copyName": "string"
                    },
                    "extendedFlags": {
                      "overRideGACPRetention": "string",
                      "useGlobalStoragePolicy": "string"
                    },
                    "drivePool": {
                      "drivePoolName": "string",
                      "drivePoolId": 0
                    },
                    "copyFlags": {},
                    "library": {
                      "libraryName": "string",
                      "libraryId": 0
                    },
                    "startTime": {
                      "time": 0
                    },
                    "useGlobalPolicy": {
                      "storagePolicyName": "string",
                      "storagePolicyId": 0
                    }
                  }
                ]
              },
              "plan": {
                "planSummary": "string",
                "planName": "string",
                "planId": 0,
                "entityInfo": {
                  "companyId": 0,
                  "companyName": "string",
                  "multiCommcellId": 0
                }
              },
              "RPOHours": "string",
              "NumberOfCopies": "string",
              "PrimaryStorageRetention": "string",
              "PrimaryStorageType": "string",
              "AssociatedEntitiesCount": "string"
            }
          }
        },
        "planName": "string",
        "type": "string",
        "selected": true
      },
      "subclientInfo": {
        "useLocalContent": true,
        "contentOperationType": 0,
        "content": [
          {
            "path": "string"
          }
        ],
        "fsSubClientProp": {
          "useGlobalFilters": "USE_CELL_LEVEL_POLICY"
        }
      },
      "distributedClusterInstanceProperties": {
        "clusterType": 2,
        "opType": 2,
        "instance": {
          "instanceId": 0,
          "instanceName": "string",
          "clientName": "string",
          "applicationId": 64
        },
        "clusterConfig": {
          "hadoopConfig": {
            "coordinatorNode": {
              "hostName": "string",
              "clientId": 0,
              "clientName": "string",
              "displayName": "string",
              "selected": true
            },
            "hadoopSites": {
              "hadoopSites": [
                {
                  "hdfsHost": "string",
                  "hdfsUser": "string"
                }
              ]
            }
          }
        },
        "dataAccessNodes": {
          "dataAccessNodes": [
            {
              "hostName": "string",
              "clientId": 0,
              "clientName": "string",
              "displayName": "string",
              "selected": true
            }
          ]
        }
      }
    },
    "entity": {
      "clientName": "string"
    }
  }
}'