createCloudHadoopNotebookInstance

Prev Next

The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.

Available in VPC

Create a Cloud Hadoop notebook.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET | POST /vhadoop/v2/createCloudHadoopNotebookInstance
Note

This guide is based on the GET method. POST method call tests can be performed through Swagger in the API Gateway service of the NAVER Cloud Platform console.

Request headers

For information about the headers common to all Cloud Hadoop APIs, see Cloud Hadoop request headers.

Request query parameters

You can use the following query parameters with your request:

Field Type Required Description
regionCode String Optional Region code
cloudHadoopNotebookName String Required Notebook name
  • Enter 3 to 15 characters using a combination of lowercase English letters, numbers, and special character "-".
  • The string must start with a lowercase English letter and end with a lowercase English letter or a number.
cloudHadoopNotebookComponent String Required Notebook component
cloudHadoopNotebookImageProductCode String Optional Notebook image code
cloudHadoopInstanceNo String Required Cluster instance number
bucketName String Required Object Storage bucket name
notebookNodeSubnetNo String Required Notebook node subnet number
notebookNodeProductCode String Optional Notebook node server type code
useNotebookBlockStorage Boolean Optional Whether to add notebook node storage
  • true | false (default)
    • true: Add.
    • false: Do not add.
notebookNodeDataStorageTypeCode String Conditional Storage type
  • SSD (default) | HDD
  • Required if useNotebookBlockStorage is true
  • It can't be changed later.
notebookNodeDataStorageSize Integer Conditional Storage capacity (GB)
  • 100-2000 (in 10 GB increments) | 4000 | 6000
  • Required if useNotebookBlockStorage is true
loginKeyName String Required Authentication key name
engineVersionCode String Optional Engine version code
responseFormatType String Optional Format of the response data
  • xml (default) | json

Request example

The request example is as follows:

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vhadoop/v2/createCloudHadoopNotebookInstance?regionCode=KR&cloudHadoopNotebookName=hd-nt1&cloudHadoopNotebookComponent=NOTEBOOK_1.0&cloudHadoopInstanceNo=2707****&bucketName=bk1&notebookNodeSubnetNo=17****&loginKeyName=**********&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
createCloudHadoopNotebookInstanceResponse Object - Response result
createCloudHadoopNotebookInstanceResponse.requestId String - ID for the request
  • UUID format
createCloudHadoopNotebookInstanceResponse.returnCode String - Response code
createCloudHadoopNotebookInstanceResponse.returnMessage String - Response message

Response status codes

For information about the HTTP status codes common to all Cloud Hadoop APIs, see Cloud Hadoop response status codes.

Response example

The response example is as follows:

{
    "createCloudHadoopNotebookInstanceResponse": {
        "totalRows": 1,
        "cloudHadoopNotebookInstanceList": [
            {
                "cloudHadoopNotebookInstanceNo": "1000*****",
                "cloudHadoopNotebookName": "hd-nt2",
                "cloudHadoopNotebookImageProductCode": "SW.VCHDP.LNX64.CNTOS.0708.HDNTB.10.B050",
                "cloudHadoopNotebookInstanceStatusName": "creating",
                "cloudHadoopNotebookInstanceStatus": {
                    "code": "INIT",
                    "codeName": "CLOUD DATABASE (VPC) Init status"
                },
                "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": "2025-02-20T10:55:49+0900",
                "loginKey": "**********",
                "objectStorageBucket": "bk1",
                "accessControlGroupNoList": [],
                "cloudHadoopClusterName": "clus1",
                "clusterDirectAccessAccount": "sshuser",
                "cloudHadoopNotebookServerInstanceList": [
                    {
                        "cloudHadoopNotebookServerName": "n-001-hd-nt2-5uln-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": "7****",
                        "subnetNo": "17****",
                        "cpuCount": 4,
                        "memorySize": 17179869184,
                        "dataStorageSize": 107374182400,
                        "isPublicSubnet": true,
                        "createDate": "2025-02-20T10:55:49+0900"
                    }
                ]
            }
        ],
        "requestId": "f3cc51e1-****-****-****-bbb30124e1da",
        "returnCode": "0",
        "returnMessage": "success"
    }
}