createCloudHadoopNotebookInstance

인쇄
공유
PDF

기사 요약

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

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

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

Cloud Hadoop 노트북을 생성합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET \| POST	/vhadoop/v2/createCloudHadoopNotebookInstance

참고

가이드는 GET 방식 기준으로 안내합니다. POST 방식의 호출 테스트는 네이버 클라우드 플랫폼 콘솔의 API Gateway 서비스에서 Swagger를 통해서 가능합니다.

요청 헤더

Cloud Hadoop API에서 공통으로 사용하는 헤더에 대한 정보는 Cloud Hadoop 요청 헤더를 참조해 주십시오.

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`regionCode`	String	Optional	리전 코드 getRegionList 참조 조회 결과의 첫 번째 리전(기본값)
`cloudHadoopNotebookName`	String	Required	노트북 이름 영문 소문자, 숫자, 특수문자 '-'를 조합하여 3~15자로 입력 문자열의 시작은 영문 소문자, 마지막은 영문 소문자 또는 숫자로 구성
`cloudHadoopNotebookComponent`	String	Required	노트북 컴포넌트 getCloudHadoopNotebookComponentList의 `code` 참조
`cloudHadoopNotebookImageProductCode`	String	Optional	노트북 이미지 코드 getCloudHadoopNotebookImageProductList의 `productCode` 참조 미입력 시 제공 중인 최신 버전 적용
`cloudHadoopInstanceNo`	String	Required	클러스터 인스턴스 번호 getCloudHadoopInstanceList 참조
`bucketName`	String	Required	Object Storage 버킷 이름 getCloudHadoopNotebookBucketList 참조
`notebookNodeSubnetNo`	String	Required	노트북노드 Subnet 번호 getCloudHadoopTargetSubnetList 참조
`notebookNodeProductCode`	String	Optional	노트북노드 서버 타입 코드 getCloudHadoopNotebookProductList 참조 기본값: 최소 사양(메모리, CPU 순)
`useNotebookBlockStorage`	Boolean	Optional	노트북노드 스토리지 추가 여부 `true` \| `false` (기본값) `true`: 추가 `false`: 추가 안 함
`notebookNodeDataStorageTypeCode`	String	Conditional	스토리지 타입 `SSD` (기본값) \| `HDD` `useNotebookBlockStorage`가 `true`인 경우, 필수 입력 추후 변경 불가
`notebookNodeDataStorageSize`	Integer	Conditional	스토리지 용량(GB) `100`~`2000` (10 GB 단위) \| `4000` \| `6000` `useNotebookBlockStorage`가 `true`인 경우, 필수 입력
`loginKeyName`	String	Required	인증키 이름 getCloudHadoopLoginKeyList 참조 SSH 방식으로 노드에 직접 접속 시 필요
`engineVersionCode`	String	Optional	엔진 버전 코드 getCloudHadoopImageProductList 참조 Rocky 클러스터 생성 시 입력 미입력 시 제공 중인 최신 버전 적용
`responseFormatType`	String	Optional	응답 데이터의 형식 `xml` (기본값) \| `json`

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://ncloud.apigw.gov-ntruss.com/vhadoop/v2/createCloudHadoopNotebookInstance?regionCode=KR&cloudHadoopNotebookName=hd-nt1&cloudHadoopNotebookComponent=NOTEBOOK_1.0&cloudHadoopInstanceNo=2707****&bucketName=bk1&notebookNodeSubnetNo=17****&loginKeyName=**********&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}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`createCloudHadoopNotebookInstanceResponse`	Object	-	응답 결과 CloudHadoopNotebookInstanceList 참조
`createCloudHadoopNotebookInstanceResponse.requestId`	String	-	요청에 대한 아이디 UUID 형식
`createCloudHadoopNotebookInstanceResponse.returnCode`	String	-	응답 코드
`createCloudHadoopNotebookInstanceResponse.returnMessage`	String	-	응답 메시지

응답 상태 코드

Cloud Hadoop API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Cloud Hadoop 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "createCloudHadoopNotebookInstanceResponse": {
        "totalRows": 1,
        "cloudHadoopNotebookInstanceList": [
            {
                "cloudHadoopNotebookInstanceNo": "1000*****",
                "cloudHadoopNotebookName": "hd-nt2",
                "cloudHadoopNotebookImageProductCode": "SW.VCHDP.LNX64.CNTOS.0708.HDNTB.10.B050",
                "cloudHadoopNotebookInstanceStatusName": "creating",
                "cloudHadoopNotebookInstanceStatus": {
                    "code": "INIT",
                    "codeName": "CLOUD DATABASE(VPC) Init 상태"
                },
                "cloudHadoopNotebookInstanceOperation": {
                    "code": "CREAT",
                    "codeName": "CLOUD DATABASE(VPC) Creat 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-20T10:55:49+0900",
                "loginKey": "**********",
                "objectStorageBucket": "bk1",
                "accessControlGroupNoList": [],
                "cloudHadoopClusterName": "clus1",
                "clusterDirectAccessAccount": "sshuser",
                "cloudHadoopNotebookServerInstanceList": [
                    {
                        "cloudHadoopNotebookServerName": "n-001-hd-nt2-5uln-hd",
                        "cloudHadoopNotebookServerRole": {
                            "code": "N",
                            "codeName": "Notebook Node"
                        },
                        "cloudHadoopNotebookServerInstanceStatusName": "creating",
                        "cloudHadoopNotebookServerInstanceStatus": {
                            "code": "PEND",
                            "codeName": "CLOUD DATABASE(VPC) 서버 Pending 상태"
                        },
                        "cloudHadoopNotebookServerInstanceOperation": {
                            "code": "CREAT",
                            "codeName": "CLOUD DATABASE(VPC) 서버 Create 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,
                        "createDate": "2025-02-20T10:55:49+0900"
                    }
                ]
            }
        ],
        "requestId": "f3cc51e1-****-****-****-bbb30124e1da",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

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

What's Next

deleteCloudHadoopNotebookInstance

요청
응답