MENU
      getDetail

        getDetail


        기사 요약

        VPC 환경에서 이용 가능합니다.

        생성한 Notebook의 상세 정보를 확인합니다.

        요청

        요청 파라미터

        파라미터명필수 여부타입제약 사항설명
        idYESString- id는 Notebooks의 getList API를 통해서 획득 가능

        요청 헤더

        공통 가이드 참조

        요청 바디

        • JSON
          {
              "id": "string"
          }
          JSON
        • XML
          <?xml version="1.0" encoding="UTF-8"?>
          <GetNotebookDetailRequest>
              <id>string</id>
          </GetNotebookDetailRequest>
          XML

        응답

        응답 바디

        • 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
          }
          JSON
        • 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>
          XML

        오류코드

        DataForest 개요 참조

        예시

        요청 예시

        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"
        }
        HTTP
        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\"}"
        Bash

        응답 예시

        • HTTP

          HTTP StatusDescription
          200OK
        • 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.naverncp.com",
                  "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
                      }
                  ]
          }
          JSON

        오류 코드 예시

        • HTTP

          HTTP StatusDescription
          404no such element
        • BASH

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

        이 문서가 도움이 되었습니까?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.