getCloudHadoopNotebookInstanceDetail

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in VPC

Searches Cloud Hadoop Notebook instance details.

Requests

Request Parameters

Parameter Name	Requirement Status	Type	Description
regionCode	No	String	Region code - Can be obtained through the getRegionList action - Default: select the first Region of the getRegionList query results
cloudHadoopNotebookInstanceNo	Yes	String	- Instance number of Cloud Hadoop Notebook that will have details be searched - Can be obtained through the getCloudHadoopNotebookInstanceList 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",
  "cloudHadoopNotebookInstanceNo": "string",
  "responseFormatType": "string"
}

Responses

Response bodies

CloudHadoopNotebookInstanceList

Errors

See Cloud Hadoop(VPC) overview.

Examples

Request Examples

GET {API_URL}/getCloudHadoopNotebookInstanceDetail
?regionCode=KR
&cloudHadoopNotebookInstanceNo=****890

Response examples

{
  "getCloudHadoopNotebookInstanceDetailResponse": {
    "totalRows": 1,
    "cloudHadoopNotebookInstanceList": [
      {
        "cloudHadoopNotebookInstanceNo": "2765818",
        "cloudHadoopNotebookName": "test123",
        "cloudHadoopNotebookImageProductCode": "SW.VCHDP.LNX64.CNTOS.0708.HDNTB.10.B050",
        "cloudHadoopNotebookInstanceStatusName": "running",
        "cloudHadoopNotebookInstanceStatus": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE(VPC) Created State"
        },
        "cloudHadoopNotebookInstanceOperation": {
          "code": "NULL",
          "codeName": "CLOUD DATABASE(VPC) Null 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-07T18:09:27+0900",
        "loginKey": "newkey",
        "objectStorageBucket": "aabbcc",
        "domain": "pri-2kcvq.hadoop.beta.ntruss.com",
        "accessControlGroupNoList": [
          "25448"
        ],
        "cloudHadoopClusterName": "fsdfds",
        "clusterDirectAccessAccount": "sshuser",
        "useNotebookBlockStorage": true,
        "cloudHadoopNotebookServerInstanceList": [
          {
            "cloudHadoopNotebookServerInstanceNo": 2765819,
            "cloudHadoopNotebookServerName": "n-001-test123-15d6-hd",
            "cloudHadoopNotebookServerInstanceStatusName": "running",
            "cloudHadoopNotebookServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) Server Running State"
            },
            "cloudHadoopNotebookServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) Server Null 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"
             },
            "uptime": "2023-02-07T18:13:44+0900",
            "createDate": "2023-02-07T18:09:27+0900"
          }
        ]
      }
    ],
    "requestId": "eb1c6002-5a80-4a5c-9b71-b037a638ab78",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

<getCloudHadoopNotebookInstanceDetailResponse>
    <requestId>0dfe66f6-62d4-4720-8f02-f460a37b871c</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <cloudHadoopNotebookInstanceList>
        <cloudHadoopNotebookInstance>
            <cloudHadoopNotebookInstanceNo>2765818</cloudHadoopNotebookInstanceNo>
            <cloudHadoopNotebookName>test123</cloudHadoopNotebookName>
            <cloudHadoopNotebookImageProductCode>SW.VCHDP.LNX64.CNTOS.0708.HDNTB.10.B050</cloudHadoopNotebookImageProductCode>
            <cloudHadoopNotebookInstanceStatusName>running</cloudHadoopNotebookInstanceStatusName>
            <cloudHadoopNotebookInstanceStatus>
                <code>CREAT</code>
                <codeName>CLOUD DATABASE(VPC) Created State</codeName>
            </cloudHadoopNotebookInstanceStatus>
            <cloudHadoopNotebookInstanceOperation>
                <code>NULL</code>
                <codeName>CLOUD DATABASE(VPC) Null 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-07T18:09:27+0900</createDate>
            <loginKey>newkey</loginKey>
            <objectStorageBucket>aabbcc</objectStorageBucket>
            <domain>pri-2kcvq.hadoop.beta.ntruss.com</domain>
            <accessControlGroupNoList>
                <accessControlGroupNo>25448</accessControlGroupNo>
            </accessControlGroupNoList>
            <cloudHadoopClusterName>fsdfds</cloudHadoopClusterName>
            <clusterDirectAccessAccount>sshuser</clusterDirectAccessAccount>
            <useNotebookBlockStorage>true</useNotebookBlockStorage>
            <cloudHadoopNotebookServerInstanceList>
                <cloudHadoopNotebookServerInstance>
                    <cloudHadoopNotebookServerInstanceNo>2765819</cloudHadoopNotebookServerInstanceNo>
                    <cloudHadoopNotebookServerName>n-001-test123-15d6-hd</cloudHadoopNotebookServerName>
                    <cloudHadoopNotebookServerInstanceStatusName>running</cloudHadoopNotebookServerInstanceStatusName>
                    <cloudHadoopNotebookServerInstanceStatus>
                        <code>RUN</code>
                        <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
                    </cloudHadoopNotebookServerInstanceStatus>
                    <cloudHadoopNotebookServerInstanceOperation>
                        <code>NOOP</code>
                        <codeName>CLOUD DATABASE(VPC) Server Null 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> 
                    <uptime>2023-02-07T18:13:44+0900</uptime>
                    <createDate>2023-02-07T18:09:27+0900</createDate>
                </cloudHadoopNotebookServerInstance>
            </cloudHadoopNotebookServerInstanceList>
        </cloudHadoopNotebookInstance>
    </cloudHadoopNotebookInstanceList>
</getCloudHadoopNotebookInstanceDetailResponse>

Was this article helpful?

What's Next

getCloudHadoopNotebookInstanceList

Table of contents

Requests
Responses
Errors
Examples