getDetail

Available in VPC

View the detailed information on the created Notebook.

Requests

Request Parameters

Request headers

See common guide.

Request bodies

• JSON

    {
        "id": "string"
    }
  

• XML

    <?xml version="1.0" encoding="UTF-8"?>
    <GetNotebookDetailRequest>
        <id>string</id>
    </GetNotebookDetailRequest>
  

Response

Response Body

• JSON

    {
      "acgName": "string",
      "acgNo":0,
      "additionalStorage": {
        "storageGB": 0,
        "storageType": "string"
      },
      "createdAt": "2023-06-07T06:28:34.992Z",
      "domain": "string",
      "id": "string",
      "loginKeyName": "string",
      "message": "string",
      "name": "string",
      "serverDesc": "string",
      "sshAccount": "string",
      "state": "ACCEPTED",
      "subnetName": "string",
      "subnetNo": 0,
      "success": true,
      "typeName": "string",
      "userConfigurations": [
        {
          "componentName": "string",
          "description": "string",
          "isMasking": true,
          "name": "string",
          "regexpDescription": "string",
          "regularExpression": "string",
          "value": "string"
        }
      ],
      "vpcName": "string",
      "vpcNo": 0
    }
  

• XML

    <?xml version="1.0" encoding="UTF-8"?>
    <GetNotebookDetailResponse>
        <acgName>string</acgName>
        <acgNo>0</acgNo>
        <additionalStorage>
            <storageGB>0</storageGB>
            <storageType>string</storageType>
        </additionalStorage>
        <createdAt>2023-06-07T06:28:51.589Z</createdAt>
        <domain>string</domain>
        <id>string</id>
        <loginKeyName>string</loginKeyName>
        <message>string</message>
        <name>string</name>
        <serverDesc>string</serverDesc>
        <sshAccount>string</sshAccount>
        <state>ACCEPTED</state>
        <subnetName>string</subnetName>
        <subnetNo>0</subnetNo>
        <success>true</success>
        <typeName>string</typeName>
        <userConfigurations>
            <componentName>string</componentName>
            <description>string</description>
            <isMasking>true</isMasking>
            <name>string</name>
            <regexpDescription>string</regexpDescription>
            <regularExpression>string</regularExpression>
            <value>string</value>
        </userConfigurations>
        <vpcName>string</vpcName>
        <vpcNo>0</vpcNo>
    </GetNotebookDetailResponse>
  

Errors

Examples

Request Examples

POST https://df.apigw.ntruss.com/api/v2/notebooks/getDetail
HOST: df.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-signature-v2: Azm1WBMWDgEONUCUbsVkB4tRIpc053uOHU8bitbQRtU=
x-ncp-apigw-timestamp: 1658898041497
x-ncp-iam-access-key: F5O55GOTR4CqYJqPDnCu
{
  "id": "7kHeVWhiRsxdRl0nXz04ri"
}

curl -X POST "https://df.apigw.ntruss.com/api/v2/notebooks/getDetail" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "x-ncp-iam-access-key: F5O55GOTR4CqYJqPDnCu" \
-H "x-ncp-apigw-timestamp: 1684750174503" \
-H "x-ncp-apigw-signature-v2: bj7hVWhEfBRCr49ztbXA4OxXpZgezJXryP83IcSFmbg=" \
-d "{ \"id\": \"7kHeVWhiRsxdRl0nXz04ri\"}"

Response examples

• HTTP

  HTTP Status	Description
  200	OK

• BASH

  {
          "success": true,
          "id": "7kHeVWhiRsxdRl0nXz04ri",
          "name": "df-notebook",
          "typeName": "Jupyter Lab",
          "state": "RUNNING",
          "vpcNo": 8717,
          "vpcName": "test-vpc",
          "subnetName": "prisub-kr",
          "acgName": "df-notebook-acg-1ss11",
          "acgNo":7178,
          "serverDesc": "vCPU 4EA, Memory 16GB, [HDD]Disk 50GB",
          "loginKeyName": "subin-beta",
          "domain": "7khevwhirsxdrl0nxz04ri-notebook.kr.df.beta.naverncp.com:18080",
          "sshAccount": "forest",
          "additionalStorage": {
              "storageGB": 0,
              "storageType": "SSD"
          },
          "userConfigurations": [
              {
              "name": "Access Password",
              "value": "",
              "componentName": "Jupyter Lab",
              "regularExpression": "^[a-zA-Z][a-zA-Z0-9]{1,7}$",
              "isMasking": true
              },
              {
              "name": "Access Key",
              "value": "",
              "componentName": "Object Storage",
              "regularExpression": ".*",
              "isMasking": true
              },
              {
              "name": "Secret Key",
              "value": "",
              "componentName": "Object Storage",
              "regularExpression": ".*",
              "isMasking": true
              }
          ]
  }
  

Errors examples

• HTTP

  HTTP Status	Description
  404	no such element

• BASH

    {
        "message": "no such element",
        "success": false
    }