createCloudHadoopNotebookInstance

Available in VPC

Create a Cloud Hadoop notebook.

Syntax

The createCloudHadoopNotebookInstance syntax is as follows:

./ncloud vhadoop createCloudHadoopNotebookInstance \
    --cloudHadoopInstanceNo <cloud-hadoop-instance-no> \
    --notebookNodeSubnetNo <notebook-node-subnet-no> \
    --cloudHadoopNotebookName <notebook-name> \
    --cloudHadoopNotebookComponent <notebook-component> \
    --notebookNodeDataStorageSize <notebook-node-storage-size> \
    --bucketName <bucket-name> \
    --loginKeyName <login-key-name> \
    [--cloudHadoopNotebookImageProductCode <notebook-image-product-code>] \
    [--engineVersionCode <engine-version-code>] \
    [--notebookNodeProductCode <notebook-node-product-code>] \
    [--useNotebookBlockStorage <true|false>] \
    [--notebookNodeDataStorageTypeCode <SSD|HDD|CB2>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

Options

This section describes the options available when running createCloudHadoopNotebookInstance.

Required options

The following options are required for createCloudHadoopNotebookInstance.

Options	Type	Required	Description
`--cloudHadoopInstanceNo`	String	Required	Cluster instance number See getCloudHadoopInstanceList.
`--notebookNodeSubnetNo`	String	Required	Notebook node subnet number See getCloudHadoopTargetSubnetList.
`--cloudHadoopNotebookName`	String	Required	Notebook 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.
`--cloudHadoopNotebookComponent`	String	Required	Notebook component See `code` of getCloudHadoopNotebookComponentList.
`--notebookNodeDataStorageSize`	Integer	Required	Notebook node storage capacity (GB) `100`-`2000` (in 10 GB increments) \| `4000` \| `6000`
`--bucketName`	String	Required	Object Storage bucket name See getCloudHadoopNotebookBucketList.
`--loginKeyName`	String	Required	Authentication key name Required when connecting directly to a node via SSH. See getCloudHadoopLoginKeyList.

Optional options

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

Options	Type	Required	Description
`--cloudHadoopNotebookImageProductCode`	String	Optional	Notebook image code If left blank, the latest available version is applied. See `productCode` of getCloudHadoopNotebookImageProductList.
`--engineVersionCode`	String	Optional	Engine version code If left blank, the latest available version is applied. Enter when creating a Rocky cluster. See getCloudHadoopImageProductList.
`--notebookNodeProductCode`	String	Optional	Notebook node server type code Default: Minimum specifications (in order of memory, CPU) See getCloudHadoopNotebookProductList.
`--useNotebookBlockStorage`	Boolean	Optional	Whether to add storage to notebook node `true` \| `false` (default) `true`: Add `false`: Do not add
`--notebookNodeDataStorageTypeCode`	String	Optional	Notebook node storage type The default value varies depending on the `generationCode` of `cloudHadoopNotebookImageProductCode`. G2: `SSD` (default) \| `HDD` G3: `CB2` (default) The data storage type can't 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 notebook is successful, the notebook's configuration information and creation status are returned.

Command

The command example is as follows:

./ncloud vhadoop createCloudHadoopNotebookInstance \
    --cloudHadoopInstanceNo 34567890 \
    --notebookNodeSubnetNo 23456790 \
    --cloudHadoopNotebookName notebook-01 \
    --cloudHadoopNotebookComponent NOTEBOOK_1.1 \
    --bucketName my-test-bucket \
    --notebookNodeDataStorageSize 100 \
    --loginKeyName test-key \
    --useNotebookBlockStorage true \
    --notebookNodeDataStorageTypeCode SSD \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "createCloudHadoopNotebookInstanceResponse": {
    "totalRows": 1,
    "cloudHadoopNotebookInstanceList": [
      {
        "cloudHadoopNotebookInstanceNo": "34567891",
        "cloudHadoopNotebookName": "notebook-01",
        "cloudHadoopNotebookImageProductCode": "SW.VCHDP.OS.LNX64.ROCKY.0810.HDNTB.B050",
        "cloudHadoopNotebookInstanceStatusName": "creating",
        "cloudHadoopNotebookInstanceStatus": {
          "code": "INIT",
          "codeName": "CLOUD DATABASE (VPC) Init status"
        },
        "cloudHadoopNotebookInstanceOperation": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE(VPC) Creat OP"
        },
        "cloudHadoopNotebookVersion": {
          "code": "NOTEBOOK1.1",
          "codeName": "Notebook 1.1"
        },
        "cloudHadoopNotebookComponent": {
          "code": "NOTEBOOK_1.1",
          "codeName": "Jupyter notebook 6.4.10 , JupyterLab : 3.2.9"
        },
        "createDate": "2026-07-06T16:26:27+0900",
        "loginKey": "test-key",
        "objectStorageBucket": "my-test-bucket",
        "accessControlGroupNoList": [],
        "cloudHadoopClusterName": "cluster-01",
        "clusterDirectAccessAccount": "sshuser",
        "cloudHadoopNotebookServerInstanceList": [
          {
            "cloudHadoopNotebookServerName": "n-001-notebook-01-9dc2-hd",
            "cloudHadoopNotebookServerRole": {
              "code": "N",
              "codeName": "Notebook Node"
            },
            "cloudHadoopNotebookServerInstanceStatusName": "creating",
            "cloudHadoopNotebookServerInstanceStatus": {
              "code": "PEND",
              "codeName": "CLOUD DATABASE (VPC) server Pending status"
            },
            "cloudHadoopNotebookServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE (VPC) server Create OP"
            },
            "cloudHadoopNotebookProductCode": "SVR.VCHDP.NTBND.STAND.C004.M016.NET.HDD.B050.G002",
            "regionCode": "KR",
            "zoneCode": "KR-2",
            "vpcNo": "12345678",
            "subnetNo": "23456790",
            "cpuCount": 4,
            "memorySize": 17179869184,
            "dataStorageSize": 107374182400,
            "isPublicSubnet": false,
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
            },
            "createDate": "2026-07-06T16:26:27+0900"
          }
        ]
      }
    ],
    "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "returnCode": "0",
    "returnMessage": "success"
  }
}