createCloudHadoopNotebookInstance

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in VPC

Create a Cloud Hadoop Notebook instance.

Request

Request parameters

Parameter name	Required	Type	Restrictions	Description
regionCode	No	String		Region code - It can be obtained through the getRegionList action Default: Select the first Region of the getRegionList query result
cloudHadoopNotebookName	Yes	String	Only English letters, numbers, hyphens (-), and Korean letters can be used The first and last character must be a lowercase English letter or number Min: 3 Max: 15	Cloud Hadoop Notebook name - It can't be duplicated
cloudHadoopNotebookImageProductCode	No	String		Cloud Hadoop Notebook image product code - It can be obtained through productCode of the getCloudHadoopNotebookImageProductList action - It is created with the default value if not entered Default: latest version of Cloud Hadoop Notebook
cloudHadoopNotebookComponent	Yes	String		Cloud Hadoop Notebook component - It can be obtained through the getCloudHadoopNotebookComponentList action
loginKeyName	Yes	String		Authentication key name - It can be obtained through the getCloudHadoopLoginKeyList action Set the SSH authentication key required to connect directly to the node
notebookNodeProductCode	No	String		Cloud Hadoop Notebook server product code - Determine the server specifications for the Cloud Hadoop Notebook instance to create - It can be obtained when calling the getCloudHadoopNotebookProductList action by setting its infraResourceDetailTypeCode to "NTBND" Default: The minimum specification is selected The minimum specification is based on 1. memory and 2. CPU
notebookNodeSubnetNo	Yes	String		Notebook node's subnet number - Select the subnet on which the Notebook node will be located - Notebook nodes are located in private/public subnets - notebookNodeSubnetNo can be obtained through the getCloudHadoopTargetSubnetList action
bucketName	Yes	String		Bucket name - Space for storing data in Object Storage - It can be obtained through the getCloudHadoopNotebookBucketList action
notebookNodeDataStorageTypeCode	Yes	String	SSD \| HDD	Notebook node's data storage type code - Data storage type can't be changed after installation - Options: SSD \| HDD - Default: SSD
notebookNodeDataStorageSize	Yes	Integer	Min: 100 Max: 2000 or 4000, 6000	Notebook node's data storage size - Can be entered in 10 GB increments from 100 GB to 2000 GB - 4000 GB or 6000 GB can also be used
useNotebookBlockStorage	No	Boolean		Whether to use Cloud Hadoop Notebook data storage - Default: false
cloudHadoopInstanceNo	Yes	String		Number of Cloud Hadoop cluster to integrated with Notebook It can be obtained through the getCloudHadoopInstanceList action
engineVersionCode	Conditional	String		Engine version code Check through getCloudHadoopImageProductList Enter only when creating with Rocky cluster, ignore CentOS specifications If not entered, it is created with the latest version currently available
responseFormatType	No	String		Response result's format type - Options: xml \| json - Default: xml

Request headers

See Cloud Hadoop (VPC) overview.

Request body

{
  "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"
}

Response

Response body

CloudHadoopNotebookInstanceList

Errors

See Cloud Hadoop (VPC) overview.

Examples

Request example

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 example

{
  "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 example

{
  "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

Request
Response
Errors
Examples