createCloudHadoopNotebookInstance

Article Summary

Share feedback

Thanks for sharing your feedback!

Available in VPC

Creates a Cloud Hadoop Notebook instance.

Requests

Request Parameters

Parameter Name	Requirement Status	Type	Restrictions	Description
regionCode	No	String		Region code - Can be obtained through the getRegionList action Default: select the first Region of the getRegionList search results
cloudHadoopNotebookName	Yes	String	Can only enter English letters, numbers, and dashes (-), and Korean letters. Must start and end with an English letter (lowercase) or a number Min: 3 Max: 15	Cloud Hadoop Notebook name - Cannot duplicate
cloudHadoopNotebookImageProductCode	No	String		Cloud Hadoop Notebook image product code - Can be obtained with the productCode of the getCloudHadoopNotebookImageProductList action - Generated in default value if data is not entered Default: Cloud Hadoop Notebook's latest version
cloudHadoopNotebookComponent	Yes	String		Cloud Hadoop Notebook Component - Can be obtained through the getCloudHadoopNotebookComponentList action
loginKeyName	Yes	String		Authentication key name - Can be obtained through the getCloudHadoopLoginKeyList action Set the SSH authentication key required for connecting directly to the node
notebookNodeProductCode	No	String		Cloud Hadoop Notebook server product code - Can decide the server specifications of the Cloud Hadoop Notebook instance to be created - Can be obtained by setting and calling as infraResourceDetailTypeCode = 'NTBND' of the getCloudHadoopNotebookProductList action Default: the minimum specifications are selected Standard of minimum specifications: 1. Memory 2. CPU
notebookNodeSubnetNo	Yes	String		Subent number of Notebook node - Can select a Subnet that will locate the Notebook node - Notebook nodes are located in private/public subnets - Can obtain notebookNodeSubnetNo through the getCloudHadoopTargetSubnetList action
bucketName	Yes	String		Bucket name - Refers to a space to store data in Object Storage - Can be obtained through the getCloudHadoopNotebookBucketList action
notebookNodeDataStorageTypeCode	Yes	String	SSD \| HDD	Data storage type code of Notebook node - Data storage type is not altered after installation - Options: SSD \| HDD - Default: SSD
notebookNodeDataStorageSize	Yes	Integer	Min: 100 Max: 2000 or 4000, 6000	Data storage size of Notebook node - Can be entered in 10 GB units between 100 GB and 2000 GB - 4000 GB and 6000 GB are also available
useNotebookBlockStorage	No	Boolean		Cloud Hadoop Notebook data storage availability - Default: false
cloudHadoopInstanceNo	Yes	String		Cloud Hadoop cluster number to be integrated with Notebook Can be obtained through the getCloudHadoopInstanceList action
responseFormatType	No	String		Format type of the response result - Options: xml \| json - Default: xml

Request headers

See Cloud Hadoop(VPC) overview.

Request bodies

{
  "regionCode": "string",
  "cloudHadoopNotebookName": "string",
  "cloudHadoopNotebookImageProductCode": "string",
  "cloudHadoopNotebookComponent": "string",
  "loginKeyName": "string",
  "bucketName": "string",
  "notebookNodeProductCode": "string",
  "notebookNodeSubnetNo": "string",
  "notebookNodeDataStorageTypeCode": "string",
  "notebookNodeDataStorageSize": 0,
  "useNotebookBlockStorage": "string",
  "cloudHadoopInstanceNo": "string",
  "responseFormatType": "string"
}

Responses

Response bodies

CloudHadoopNotebookInstanceList

Errors

See Cloud Hadoop(VPC) overview.

Examples

Request Examples

GET {API_URL}/createCloudHadoopNotebookInstance
?regionCode=KR
&cloudHadoopNotebookName=test***
&cloudHadoopNotebookImageProductCode=SW.VCHDP.LNX64.CNTOS.0708.HDNTB.10.B050
&cloudHadoopNotebookComponent=NOTEBOOK_1.0 
&loginKeyName=key****
&notebookNodeProductCode=SVR.VCHDP.NTBND.STAND.C004.M016.NET.HDD.B050.G002
&notebookNodeSubnetNo=12**
&bucketName=buc***
&notebookNodeDataStorageTypeCode=SSD
&notebookNodeDataStorageSize=100
&useNotebookBlockStorage=true
&cloudHadoopInstanceNo=12**

Response examples

{
  "createCloudHadoopNotebookInstanceResponse": {
    "totalRows": 1,
    "cloudHadoopNotebookInstanceList": [
      {
        "cloudHadoopNotebookInstanceNo": "2766154",
        "cloudHadoopNotebookName": "test12",
        "cloudHadoopNotebookImageProductCode": "SW.VCHDP.LNX64.CNTOS.0708.HDNTB.10.B050",
        "cloudHadoopNotebookInstanceStatusName": "creating",
        "cloudHadoopNotebookInstanceStatus": {
          "code": "INIT",
          "codeName": "CLOUD DATABASE(VPC) Init State"
        },
        "cloudHadoopNotebookInstanceOperation": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE(VPC) Creat OP"
        },
        "cloudHadoopNotebookVersion": {
          "code": "NOTEBOOK1.0",
          "codeName": "Notebook 1.0"
        },
        "cloudHadoopNotebookComponent": {
          "code": "NOTEBOOK_1.0",
          "codeName": "Jupyter notebook 6.4.10 , JupyterLab : 3.2.9"
        },
        "createDate": "2023-02-07T20:40:50+0900",
        "loginKey": "newkey",
        "objectStorageBucket": "aabbcc",
        "accessControlGroupNoList": [],
        "cloudHadoopClusterName": "fsdfds",
        "clusterDirectAccessAccount": "sshuser",
        "useNotebookBlockStorage": true,
        "cloudHadoopNotebookServerInstanceList": [
          {
            "cloudHadoopNotebookServerName": "n-001-test12-15dk-hd",
            "cloudHadoopNotebookServerInstanceStatusName": "creating",
            "cloudHadoopNotebookServerInstanceStatus": {
              "code": "PEND",
              "codeName": "CLOUD DATABASE(VPC) Server Pending State"
            },
            "cloudHadoopNotebookServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE(VPC) Server Create OP"
            },
            "cloudHadoopNotebookServerRole": {
              "code": "N",
              "codeName": "Notebook Node"
            }, 
            "cloudHadoopNotebookProductCode": "SVR.VCHDP.NTBND.STAND.C004.M016.NET.HDD.B050.G002",
            "regionCode": "KR",
            "zoneCode": "KR-2",
            "vpcNo": "3977",
            "subnetNo": "5747",
            "cpuCount": 4,
            "memorySize": 17179869184,
            "dataStorageSize": 107374182400,
            "isPublicSubnet": false,
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
             },
            "createDate": "2023-02-07T20:40:50+0900"
          }
        ]
      }
    ],
    "requestId": "9a425589-09e1-4202-94df-f2102dcca882",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

<createCloudHadoopNotebookInstanceResponse>
  <requestId>ff98794d-34b7-42ac-8154-14b7afa479cb</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <cloudHadoopNotebookInstanceList>
    <cloudHadoopNotebookInstance>
      <cloudHadoopNotebookInstanceNo>2766068</cloudHadoopNotebookInstanceNo>
      <cloudHadoopNotebookName>test123</cloudHadoopNotebookName>
      <cloudHadoopNotebookImageProductCode>SW.VCHDP.LNX64.CNTOS.0708.HDNTB.10.B050</cloudHadoopNotebookImageProductCode>
      <cloudHadoopNotebookInstanceStatusName>creating</cloudHadoopNotebookInstanceStatusName>
      <cloudHadoopNotebookInstanceStatus>
        <code>INIT</code>
        <codeName>CLOUD DATABASE(VPC) Init State</codeName>
      </cloudHadoopNotebookInstanceStatus>
      <cloudHadoopNotebookInstanceOperation>
        <code>CREAT</code>
        <codeName>CLOUD DATABASE(VPC) Creat OP</codeName>
      </cloudHadoopNotebookInstanceOperation>
      <cloudHadoopNotebookVersion>
        <code>NOTEBOOK1.0</code>
        <codeName>Notebook 1.0</codeName>
      </cloudHadoopNotebookVersion>
      <cloudHadoopNotebookComponent>
        <code>NOTEBOOK_1.0</code>
        <codeName>Jupyter notebook 6.4.10 , JupyterLab : 3.2.9</codeName>
      </cloudHadoopNotebookComponent>
      <createDate>2023-02-07T20:16:55+0900</createDate>
      <loginKey>newkey</loginKey>
      <objectStorageBucket>aabbcc</objectStorageBucket>
      <accessControlGroupNoList/>
      <cloudHadoopClusterName>fsdfds</cloudHadoopClusterName>
      <clusterDirectAccessAccount>sshuser</clusterDirectAccessAccount>
      <useNotebookBlockStorage>true</useNotebookBlockStorage>
      <cloudHadoopNotebookServerInstanceList>
        <cloudHadoopNotebookServerInstance>
          <cloudHadoopNotebookServerName>n-001-test123-15d8-hd</cloudHadoopNotebookServerName>
          <cloudHadoopNotebookServerInstanceStatusName>creating</cloudHadoopNotebookServerInstanceStatusName>
          <cloudHadoopNotebookServerInstanceStatus>
            <code>PEND</code>
            <codeName>CLOUD DATABASE(VPC) Server Pending State</codeName>
          </cloudHadoopNotebookServerInstanceStatus>
          <cloudHadoopNotebookServerInstanceOperation>
            <code>CREAT</code>
            <codeName>CLOUD DATABASE(VPC) Server Create OP</codeName>
          </cloudHadoopNotebookServerInstanceOperation>
          <cloudHadoopNotebookServerRole>
            <code>N</code>
            <codeName>Notebook Node</codeName>
          </cloudHadoopNotebookServerRole> 
          <cloudHadoopNotebookProductCode>SVR.VCHDP.NTBND.STAND.C004.M016.NET.HDD.B050.G002</cloudHadoopNotebookProductCode>
          <regionCode>KR</regionCode>
          <zoneCode>KR-2</zoneCode>
          <vpcNo>3977</vpcNo>
          <subnetNo>5747</subnetNo>
          <cpuCount>4</cpuCount>
          <memorySize>17179869184</memorySize>
          <dataStorageSize>107374182400</dataStorageSize>
          <isPublicSubnet>false</isPublicSubnet>
          <dataStorageType>
    <code>SSD</code>
    <codeName>SSD</codeName>
</dataStorageType> 
          <createDate>2023-02-07T20:16:55+0900</createDate>
        </cloudHadoopNotebookServerInstance>
      </cloudHadoopNotebookServerInstanceList>
    </cloudHadoopNotebookInstance>
  </cloudHadoopNotebookInstanceList>
</createCloudHadoopNotebookInstanceResponse>

Error response examples

{
  "responseError": {
    "returnCode": "5001386",
    "returnMessage": "Notebook node storage type/capacity selection is available only if you select Add Notebook Node Storage."
  }
}

Was this article helpful?

What's Next

deleteCloudHadoopInstance

Table of contents

Requests
Responses
Errors
Examples