createCloudHadoopInstance

Prev Next

Available in VPC

Create a Cloud Hadoop cluster.

Syntax

The createCloudHadoopInstance syntax is as follows:

./ncloud vhadoop createCloudHadoopInstance \
    --vpcNo <vpc-no> \
    --edgeNodeSubnetNo <edge-node-subnet-no> \
    --masterNodeSubnetNo <master-node-subnet-no> \
    --workerNodeSubnetNo <worker-node-subnet-no> \
    --cloudHadoopClusterName <cluster-name> \
    --cloudHadoopClusterTypeCode <cluster-type-code> \
    --masterNodeDataStorageSize <master-node-storage-size> \
    --workerNodeDataStorageSize <worker-node-storage-size> \
    --bucketName <bucket-name> \
    --cloudHadoopAdminUserName <admin-user-name> \
    --cloudHadoopAdminUserPassword <admin-user-password> \
    --loginKeyName <login-key-name> \
    [--cloudHadoopImageProductCode <image-product-code>] \
    [--engineVersionCode <engine-version-code>] \
    [--cloudHadoopAddOnCodeList <add-on-code-list>] \
    [--useDataCatalog <true|false>] \
    [--useKdc <true|false>] \
    [--kdcRealm <kdc-realm>] \
    [--kdcPassword <kdc-password>] \
    [--useBootstrapScript <true|false>] \
    [--bootstrapScript <bootstrap-script>] \
    [--edgeNodeProductCode <edge-node-product-code>] \
    [--masterNodeProductCode <master-node-product-code>] \
    [--masterNodeDataStorageTypeCode <SSD|HDD|CB2>] \
    [--workerNodeProductCode <worker-node-product-code>] \
    [--workerNodeCount <worker-node-count>] \
    [--workerNodeDataStorageTypeCode <SSD|HDD|CB2>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

Options

This section describes the options available when running createCloudHadoopInstance.

Required options

The following options are required for createCloudHadoopInstance.

Options Type Required Description
--vpcNo String Required VPC number
--edgeNodeSubnetNo String Required Edge node subnet number
--masterNodeSubnetNo String Required Master node subnet number
--workerNodeSubnetNo String Required Worker node subnet number
--cloudHadoopClusterName String Required Cluster name
  • Enter 3-15 characters, including lowercase English letters, numbers, and special character -.
  • The string must begin with an English letter and end with an English letter or number.
  • Can't be duplicated.
--cloudHadoopClusterTypeCode String Required Cluster type code
--masterNodeDataStorageSize Integer Required Master node storage capacity (GB)
  • 100-2000 (in 10 GB increments) | 4000 | 6000
--workerNodeDataStorageSize Integer Required Worker node storage capacity (GB)
  • 100-2000 (in 10 GB increments) | 4000 | 6000
--bucketName String Required Object Storage bucket name
--cloudHadoopAdminUserName String Required Cluster admin account username
  • Enter 3-15 characters, including lowercase English letters, numbers, and special character -.
  • The string must begin with an English letter and end with an English letter or number.
  • Required for Ambari console access.
--cloudHadoopAdminUserPassword String Required Cluster admin account password
  • Enter 8-20 characters, including English letters, numbers, and special characters.
  • The special characters ' " ₩ / & ` and spaces can't be used.
  • Required for Ambari console access.
--loginKeyName String Required Authentication key name
--kdcRealm String Conditional KDC realm information
  • Only domain rules in realm format are allowed.
  • Required if useKdc is set to true.
--kdcPassword String Conditional KDC admin account password
  • Enter 8-20 characters, including English letters, numbers, and special characters.
  • The special characters ' " ₩ / & ` and spaces can't be used.
  • Required if useKdc is set to true.
--bootstrapScript String Conditional Bootstrap script
  • 1-1024 bytes.
  • Enter the folder and file names within the bucket.
  • File names must consist of English characters only; spaces and special characters can't be used.
  • Scripts can only be executed on buckets that are integrated with the cluster.
  • Required if useBootstrapScript is set to true.

Optional options

These are the optional options for createCloudHadoopInstance. Options that are not specified will use their default values.

Options Type Required Description
--cloudHadoopImageProductCode String Optional Cluster image code
--engineVersionCode String Optional Engine version code
--cloudHadoopAddOnCodeList List Optional Cluster add-on component list
  • You can enter multiple items separated by spaces (e.g., --cloudHadoopAddOnCodeList PRESTO HBASE).
  • Applicable to Cloud Hadoop version 1.5 or later.
  • See getCloudHadoopAddOnList.
--useDataCatalog Boolean Optional Whether to use the Data Catalog service
  • true | false (default)
    • true: The Hive metastore is provided through the Data Catalog service catalog.
    • false: Disabled.
  • Usage requirements.
    • Data Catalog service must be enabled and operating normally.
    • Cloud Hadoop version 2.0 or later.
--useKdc Boolean Optional Whether to use Kerberos authentication configuration
  • true | false (default)
    • true: Enabled.
    • false: Disabled.
  • When used, it provides KDC server redundancy for the master node.
--useBootstrapScript Boolean Optional Whether to use bootstrap script
  • true | false (default)
    • true: Enabled.
    • false: Disabled.
  • If enabled, the script will be pre-run on all nodes.
--edgeNodeProductCode String Optional Edge node server type code
--masterNodeProductCode String Optional Master node server type code
--masterNodeDataStorageTypeCode String Optional Master node storage type
  • The default value varies depending on generationCode of cloudHadoopImageProductCode.
    • G2: SSD (default) | HDD
    • G3: CB2 (default)
  • The data storage type cannot be changed after installation.
--workerNodeProductCode String Optional Worker node server type code
--workerNodeCount Integer Optional Number of worker nodes
  • 2-8 (default: 2)
--workerNodeDataStorageTypeCode String Optional Worker node storage type
  • The default value varies depending on the generationCode of cloudHadoopImageProductCode.
    • G2: SSD (default) | HDD
    • G3: CB2 (default)
  • The data storage type cannot be changed after installation.

Common options

For information about the options common to all vhadoop subcommands, see Cloud Hadoop (VPC) options.

Examples

If the request to create a Cloud Hadoop cluster is successful, the cluster's configuration information and creation status are returned.

Command

The command example is as follows:

./ncloud vhadoop createCloudHadoopInstance \
    --vpcNo 12345678 \
    --edgeNodeSubnetNo 23456789 \
    --masterNodeSubnetNo 23456790 \
    --workerNodeSubnetNo 23456790 \
    --cloudHadoopClusterName cluster-01 \
    --cloudHadoopClusterTypeCode CORE_HADOOP_WITH_SPARK \
    --masterNodeDataStorageSize 100 \
    --workerNodeDataStorageSize 100 \
    --bucketName my-test-bucket \
    --cloudHadoopAdminUserName adminuser \
    --cloudHadoopAdminUserPassword Examplepw123! \
    --loginKeyName test-key \
    --cloudHadoopImageProductCode SW.VCHDP.OS.LNX64.ROCKY.0810.HDP.B050 \
    --engineVersionCode HADOOP2.2 \
    --workerNodeCount 2 \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "createCloudHadoopInstanceResponse": {
    "totalRows": 1,
    "cloudHadoopInstanceList": [
      {
        "cloudHadoopInstanceNo": "34567890",
        "cloudHadoopClusterName": "cluster-01",
        "cloudHadoopInstanceStatusName": "creating",
        "cloudHadoopInstanceStatus": {
          "code": "INIT",
          "codeName": "CLOUD DATABASE (VPC) Init status"
        },
        "cloudHadoopInstanceOperation": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE(VPC) Creat OP"
        },
        "cloudHadoopClusterType": {
          "code": "CORE_HADOOP_WITH_SPARK",
          "codeName": "Core Hadoop with Spark : HDFS(3.1.1), YARN(3.1.1), Zookeeper(3.4.9), Ranger(2.0.0), HIVE(3.1.2), Hue(4.8.0), Zeppelin Notebook(0.11.2), Spark (2.4.8)"
        },
        "cloudHadoopVersion": {
          "code": "HADOOP2.2",
          "codeName": "Cloud Hadoop 2.2"
        },
        "cloudHadoopAddOnList": [],
        "ambariServerHost": "e-001-cluster-01-9d5z-hd",
        "clusterDirectAccessAccount": "sshuser",
        "loginKey": "test-key",
        "objectStorageBucket": "my-test-bucket",
        "cloudHadoopImageProductCode": "SW.VCHDP.OS.LNX64.ROCKY.0810.HDP.B050",
        "isHa": true,
        "createDate": "2026-07-06T13:58:52+0900",
        "useDataCatalog": false,
        "accessControlGroupNoList": [],
        "cloudHadoopServerInstanceList": [
          {
            "cloudHadoopServerName": "e-001-cluster-01-9d5z-hd",
            "cloudHadoopServerRole": {
              "code": "E",
              "codeName": "Edge Node"
            },
            "cloudHadoopServerInstanceStatusName": "creating",
            "cloudHadoopServerInstanceStatus": {
              "code": "PEND",
              "codeName": "CLOUD DATABASE (VPC) server Pending status"
            },
            "cloudHadoopServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE (VPC) server Create OP"
            },
            "cloudHadoopProductCode": "SVR.VCHDP.EDGND.STAND.C004.M016.NET.HDD.B050.G002",
            "regionCode": "KR",
            "zoneCode": "KR-2",
            "vpcNo": "12345678",
            "vpcName": "vpc-01",
            "subnetNo": "23456789",
            "subnetName": "public-subnet",
            "isPublicSubnet": true,
            "dataStorageSize": 107374182400,
            "cpuCount": 4,
            "memorySize": 17179869184,
            "createDate": "2026-07-06T13:58:52+0900"
          },
          {
            "cloudHadoopServerName": "m-001-cluster-01-9d5x-hd",
            "cloudHadoopServerRole": {
              "code": "M",
              "codeName": "Master Node"
            },
            "cloudHadoopServerInstanceStatusName": "creating",
            "cloudHadoopServerInstanceStatus": {
              "code": "PEND",
              "codeName": "CLOUD DATABASE (VPC) server Pending status"
            },
            "cloudHadoopServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE (VPC) server Create OP"
            },
            "cloudHadoopProductCode": "SVR.VCHDP.MSTDT.STAND.C004.M016.NET.HDD.B050.G002",
            "regionCode": "KR",
            "zoneCode": "KR-2",
            "vpcNo": "12345678",
            "vpcName": "vpc-01",
            "subnetNo": "23456790",
            "subnetName": "private-subnet",
            "isPublicSubnet": false,
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            },
            "dataStorageSize": 107374182400,
            "cpuCount": 4,
            "memorySize": 17179869184,
            "createDate": "2026-07-06T13:58:52+0900"
          },
          {
            "cloudHadoopServerName": "m-002-cluster-01-9d5y-hd",
            "cloudHadoopServerRole": {
              "code": "M",
              "codeName": "Master Node"
            },
            "cloudHadoopServerInstanceStatusName": "creating",
            "cloudHadoopServerInstanceStatus": {
              "code": "PEND",
              "codeName": "CLOUD DATABASE (VPC) server Pending status"
            },
            "cloudHadoopServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE (VPC) server Create OP"
            },
            "cloudHadoopProductCode": "SVR.VCHDP.MSTDT.STAND.C004.M016.NET.HDD.B050.G002",
            "regionCode": "KR",
            "zoneCode": "KR-2",
            "vpcNo": "12345678",
            "vpcName": "vpc-01",
            "subnetNo": "23456790",
            "subnetName": "private-subnet",
            "isPublicSubnet": false,
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            },
            "dataStorageSize": 107374182400,
            "cpuCount": 4,
            "memorySize": 17179869184,
            "createDate": "2026-07-06T13:58:52+0900"
          },
          {
            "cloudHadoopServerName": "d-001-cluster-01-9d60-hd",
            "cloudHadoopServerRole": {
              "code": "D",
              "codeName": "Data Node"
            },
            "cloudHadoopServerInstanceStatusName": "creating",
            "cloudHadoopServerInstanceStatus": {
              "code": "PEND",
              "codeName": "CLOUD DATABASE (VPC) server Pending status"
            },
            "cloudHadoopServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE (VPC) server Create OP"
            },
            "cloudHadoopProductCode": "SVR.VCHDP.MSTDT.STAND.C004.M016.NET.HDD.B050.G002",
            "regionCode": "KR",
            "zoneCode": "KR-2",
            "vpcNo": "12345678",
            "vpcName": "vpc-01",
            "subnetNo": "23456790",
            "subnetName": "private-subnet",
            "isPublicSubnet": false,
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            },
            "dataStorageSize": 107374182400,
            "cpuCount": 4,
            "memorySize": 17179869184,
            "createDate": "2026-07-06T13:58:52+0900"
          },
          {
            "cloudHadoopServerName": "d-002-cluster-01-9d61-hd",
            "cloudHadoopServerRole": {
              "code": "D",
              "codeName": "Data Node"
            },
            "cloudHadoopServerInstanceStatusName": "creating",
            "cloudHadoopServerInstanceStatus": {
              "code": "PEND",
              "codeName": "CLOUD DATABASE (VPC) server Pending status"
            },
            "cloudHadoopServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE (VPC) server Create OP"
            },
            "cloudHadoopProductCode": "SVR.VCHDP.MSTDT.STAND.C004.M016.NET.HDD.B050.G002",
            "regionCode": "KR",
            "zoneCode": "KR-2",
            "vpcNo": "12345678",
            "vpcName": "vpc-01",
            "subnetNo": "23456790",
            "subnetName": "private-subnet",
            "isPublicSubnet": false,
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            },
            "dataStorageSize": 107374182400,
            "cpuCount": 4,
            "memorySize": 17179869184,
            "createDate": "2026-07-06T13:58:52+0900"
          }
        ]
      }
    ],
    "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "returnCode": "0",
    "returnMessage": "success"
  }
}