create

인쇄
공유
PDF

기사 요약

이 요약이 도움이 되었나요?

의견을 보내 주셔서 감사합니다.

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

Notebook을 생성합니다.

요청

요청 파라미터

파라미터명	필수 여부	타입	제약 사항	설명
accountId	YES	String		- 계정 식별자 UUID(base62) - accountId는 Accounts의 getList API를 통해서 획득 가능
addStorage	YES	Boolean	true 일 때, storageType, storageGB 필수 입력	- 별도의 Block Storage 사용 여부 Default : false
bucketName	Yes	String		- 버킷 이름 - Object Storage에 데이터를 저장하기 위한 공간을 의미 - 잠금 설정되지 않은 버킷과 연동 - 연동한 버킷은 이후 잠금 설정할 수 없음
loginKeyName	YES	String		- loginKeyName은 Notebooks의 getLoginKeyList API를 통해서 획득 가능
name	YES	String	최소 3자에서 최대 15자까지 입력 가능 영문자(소문자), 숫자, 하이픈('-')으로만 구성 첫글자는 영문자이고 마지막 글자는 영문자 또는 숫자	- 노트북 이름 - 중복으로 사용할 수 없음
serverTypeCode	YES	String		- serverTypeCode Notebooks의 getServerTypeList API를 통해 확인 가능
storageGB	NO	Integer	100~2000 또는 4000, 6000 만 입력 가능	- 추가 Block Storage 크기
storageType	NO	String		- 추가 Block Storage 타입 Option : SSD \| HDD Default : SSD
subnetNo	YES	Integer		- subnetNo는 Notebooks의 getSubnetList API를 통해 확인 가능
typeCode	YES	String		- typeCode는 Notebooks의 getTypeList API를 통해 확인 가능
typeName	YES	String		- typeName는 Notebooks의 getTypeList API를 통해 확인 가능
userConfigurations	YES	String		- userConfigurations는 Notebooks의 getUserConfigurationSpecList API를 통해 확인 가능
vpcNo	YES	Integer		- vpcNo는 Notebooks의 getVpcList API를 통해 확인 가능

요청 헤더

공통 가이드 참조

요청 바디

JSON

{
  "accountId": "string",
  "addStorage": false,
  "loginKeyName": "string",
  "name": "string",
  "serverTypeCode": "string",
  "storageGB": 0,
  "storageType": "string",
  "subnetNo": 0,
  "typeCode": "string",
  "typeName": "string",
  "userConfigurations": [
    {
      "componentName": "string",
      "name": "string",
      "value": "string"
    }
  ],
  "vpcNo": 0
}

XML

<?xml version="1.0" encoding="UTF-8"?>
<CreateNotebookRequest>
  <accountId>string</accountId>
  <addStorage>true</addStorage>
  <loginKeyName>string</loginKeyName>
  <name>string</name>
  <serverTypeCode>string</serverTypeCode>
  <storageGB>0</storageGB>
  <storageType>string</storageType>
  <subnetNo>0</subnetNo>
  <typeCode>string</typeCode>
  <typeName>string</typeName>
  <userConfigurations>
    <componentName>string</componentName>
    <name>string</name>
    <value>string</value>
  </userConfigurations>
  <vpcNo>0</vpcNo>
</CreateNotebookRequest>

응답

응답 바디

JSON

{
  "id": "string",
  "message": "string",
  "success": true
}

XML

<?xml version="1.0" encoding="UTF-8"?>
<CreateNotebookResponse>
  <id>string</id>
  <message>string</message>
  <success>true</success>
</CreateNotebookResponse>

오류코드

DataForest 개요 참조

예시

요청 예시

HTTP

POST https://df.apigw.ntruss.com/api/v2/notebooks/create
HOST: df.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=
{
    "accountId": "6COytUeFjA7b8eOhqdL5zL",
    "addStorage": false,
    "loginKeyName": "user-api-key",
    "name": "api-notebook",
    "serverTypeCode": "SVR.DFRNT.STAND.C004.M016.HDD.B050.G002",
    "subnetNo": 83356,
     "typeCode": "SW.DFRNT.OS.LNX64.CNTOS.0708.B050",
    "typeName": "Jupyter Lab",
     "userConfigurations": [
            {
            "name": "Access Password",
            "value": "testTest123@",
            "componentName": "Jupyter Lab",
            "regularExpression": "^(?=.*[0-9])(?=.*[a-zA-Z])(?=.*[!@#$%^+\\-=]).{8,20}$",
            "isMasking": true,
            "isMandatory": true
            }
         ],
    "vpcNo": 34754
 }

BASH

curl -X POST "https://df.apigw.ntruss.com/api/v2/notebooks/create" \
-H "accept: application/json" -H "Content-Type: application/json" \
-H "x-ncp-iam-access-key: F5O55GOTR4CqYJqPDnCu" \
-H "x-ncp-apigw-timestamp: 1685414533742" \
-H "x-ncp-apigw-signature-v2: h4OnKdkbBcxSfc1w02qCLdSX/cFWdqwZUE57jVQYcSA=" \
-d "{ \"accountId\": \"6COytUeFjA7b8eOhqdL5zL\", 
    \"addStorage\": false,
    \"loginKeyName\": \"user-api-key\", 
    \"name\": \"api-notebook\", 
    \"serverTypeCode\": \"SVR.DFRNT.STAND.C004.M016.HDD.B050.G002\",
    \"subnetNo\": 83356, \"typeCode\": \"SW.DFRNT.OS.LNX64.CNTOS.0708.B050\", 
    \"typeName\": \"Jupyter Lab\", 
    \"userConfigurations\": [ { \"name\": \"Access Password\", \"value\": \"testTest123@\", \"componentName\": \"Jupyter Lab\", \"regularExpression\": \"^(?=.*[0-9])(?=.*[a-zA-Z])(?=.*[!@#$%^+\\\\-=]).{8,20}$\", \"isMasking\": true, \"isMandatory\": true } ], 
    \"vpcNo\": 34754 }"

응답 예시

HTTP
HTTP Status Description
200 OK

HTTP Status	Description
200	OK

BASH

  {
      "success": true,
      "id": "8xCT2TqPHPlakNZztTf3qx"
  }

오류 코드 예시

HTTP
HTTP Status Description
403 not allowed to access

HTTP Status	Description
403	not allowed to access

BASH

  {
      "message": "invalid request parameter (constraint violation Not available, notebook user configuration 'Jupyter Lab.Access Password')",
      "success": false
  }

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

What's Next

setUserConfigurationList

요청
응답
오류코드
예시