deleteCloudHadoopNotebookInstance

Prev Next

Available in VPC

Delete a Cloud Hadoop notebook.

Request

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

Method URI
GET | POST /vhadoop/v2/deleteCloudHadoopNotebookInstance
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
cloudHadoopNotebookInstanceNo String Required Notebook instance number
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/deleteCloudHadoopNotebookInstance?regionCode=KR&cloudHadoopNotebookInstanceNo=1000*****&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
deleteCloudHadoopNotebookInstanceResponse Object - Response result
deleteCloudHadoopNotebookInstanceResponse.requestId String - ID for the request
  • UUID format
deleteCloudHadoopNotebookInstanceResponse.returnCode String - Response code
deleteCloudHadoopNotebookInstanceResponse.returnMessage String - Response message

Response status codes

For response status codes common to all Cloud Hadoop APIs, see Cloud Hadoop response status codes.

Response example

The response example is as follows:

{
    "deleteCloudHadoopNotebookInstanceResponse": {
        "totalRows": 1,
        "cloudHadoopNotebookInstanceList": [
            {
                "cloudHadoopNotebookInstanceNo": "1000*****",
                "cloudHadoopNotebookName": "hd-nt2",
                "cloudHadoopNotebookImageProductCode": "SW.VCHDP.LNX64.CNTOS.0708.HDNTB.10.B050",
                "cloudHadoopNotebookInstanceStatusName": "deleted",
                "cloudHadoopNotebookInstanceStatus": {
                    "code": "DEL",
                    "codeName": "CLOUD DATABASE (VPC) Deleted status"
                },
                "cloudHadoopNotebookInstanceOperation": {
                    "code": "DEL",
                    "codeName": "CLOUD DATABASE(VPC) Delete 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-20T11:48:46+0900",
                "loginKey": "**********",
                "objectStorageBucket": "bk1",
                "domain": "pub-******.hadoop.ntruss.com",
                "accessControlGroupNoList": [
                    "20****"
                ],
                "cloudHadoopClusterName": "clus1",
                "clusterDirectAccessAccount": "sshuser",
                "cloudHadoopNotebookServerInstanceList": [
                    {
                        "cloudHadoopNotebookServerInstanceNo": 1000*****,
                        "cloudHadoopNotebookServerName": "n-001-hd-nt1-5umq-hd",
                        "cloudHadoopNotebookServerRole": {
                            "code": "N",
                            "codeName": "Notebook Node"
                        },
                        "cloudHadoopNotebookServerInstanceStatusName": "deleting",
                        "cloudHadoopNotebookServerInstanceStatus": {
                            "code": "RUN",
                            "codeName": "CLOUD DATABASE (VPC) server Running status"
                        },
                        "cloudHadoopNotebookServerInstanceOperation": {
                            "code": "DEL",
                            "codeName": "CLOUD DATABASE (VPC) server Delete 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,
                        "uptime": "2025-02-20T11:53:33+0900",
                        "createDate": "2025-02-20T11:48:46+0900"
                    }
                ]
            }
        ],
        "requestId": "1f58be4f-****-****-****-cd89b56366d1",
        "returnCode": "0",
        "returnMessage": "success"
    }
}