---
title: "getCloudHadoopNotebookInstanceList"
slug: "analytics-vhadoop-getcloudhadoopnotebookinstancelist"
updated: 2026-10-22T10:46:55Z
published: 2026-10-22T10:46:55Z
canonical: "api-gov.ncloud-docs.com/analytics-vhadoop-getcloudhadoopnotebookinstancelist"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api-gov.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# getCloudHadoopNotebookInstanceList

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

Cloud Hadoop 노트북 목록을 조회합니다.

## 요청

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

| 메서드 | URI |
| --- | --- |
| GET \| POST | /vhadoop/v2/getCloudHadoopNotebookInstanceList |

참고

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

### 요청 헤더

Cloud Hadoop API에서 공통으로 사용하는 헤더에 대한 정보는 [Cloud Hadoop 요청 헤더](/docs/analytics-vhadoop#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)를 참조해 주십시오.

### 요청 쿼리 파라미터

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

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `regionCode` | String | Optional | 리전 코드 - [getRegionList](/docs/compute-vserver-server-common-getregionlist) 참조 - 조회 결과의 첫 번째 리전(기본값) |
| `zoneCode` | String | Optional | 존 코드로 필터링 - [getZoneList](/docs/compute-vserver-server-common-getzonelist) 참조 |
| `vpcNo` | String | Optional | VPC 번호로 필터링 - [getCloudHadoopTargetVpcList](/docs/analytics-vhadoop-getcloudhadooptargetvpclist) 참조 |
| `subnetNo` | String | Optional | Subnet 번호로 필터링 - [getCloudHadoopTargetSubnetList](/docs/analytics-vhadoop-getcloudhadooptargetsubnetlist) 참조 |
| `cloudHadoopNotebookName` | String | Optional | 노트북 이름으로 필터링 |
| `cloudHadoopNotebookInstanceNoList` | Array | Optional | 노트북 인스턴스 번호 목록 - 노트북 인스턴스 번호로 필터링 - <예시> `cloudHadoopNotebookInstanceNoList.1=1234&amp;cloudHadoopNotebookInstanceNoList.2=2345` |
| `cloudHadoopNotebookServerName` | String | Optional | 노트북노드 서버 이름으로 필터링 |
| `cloudHadoopNotebookServerInstanceNoList` | Array | Optional | 노트북노드 서버 인스턴스 번호 목록 - 노트북노드 서버 인스턴스 번호로 필터링 - <예시> `cloudHadoopNotebookServerInstanceNoList.1=1234&amp;cloudHadoopNotebookServerInstanceNoList.2=2345` |
| `pageNo` | Integer | Optional | 페이지 번호 - 0~N (기본값: 0) |
| `pageSize` | Integer | Optional | 페이지 출력 수 - 1~N (기본값: 1) |
| `responseFormatType` | String | Optional | 응답 데이터의 형식 - `xml` (기본값) \| `json` |

### 요청 예시

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

```
curl --location --request GET 'https://ncloud.apigw.gov-ntruss.com/vhadoop/v2/getCloudHadoopNotebookInstanceList
?regionCode=KR
&cloudHadoopNotebookInstanceNoList.1=1000*****
&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}'
```

## 응답

응답 형식을 설명합니다.

### 응답 바디

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

| 필드 | 타입 | 필수 여부 | 설명 |
| --- | --- | --- | --- |
| `getCloudHadoopNotebookInstanceListResponse` | Object | - | 응답 결과 - [CloudHadoopNotebookInstanceList](/docs/common-vapidatatype-cloudhadoopnotebookinstancelist) 참조 |
| `getCloudHadoopNotebookInstanceListResponse.requestId` | String | - | 요청에 대한 아이디 - UUID 형식 |
| `getCloudHadoopNotebookInstanceListResponse.returnCode` | String | - | 응답 코드 |
| `getCloudHadoopNotebookInstanceListResponse.returnMessage` | String | - | 응답 메시지 |

### 응답 상태 코드

Cloud Hadoop API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 [Cloud Hadoop 응답 상태 코드](/docs/analytics-vhadoop#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)를 참조해 주십시오.

### 응답 예시

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

```
{
    "getCloudHadoopNotebookInstanceListResponse": {
        "totalRows": 1,
        "cloudHadoopNotebookInstanceList": [
            {
                "cloudHadoopNotebookInstanceNo": "1000*****",
                "cloudHadoopNotebookName": "hd-nt2",
                "cloudHadoopNotebookImageProductCode": "SW.VCHDP.LNX64.CNTOS.0708.HDNTB.10.B050",
                "cloudHadoopNotebookInstanceStatusName": "running",
                "cloudHadoopNotebookInstanceStatus": {
                    "code": "CREAT",
                    "codeName": "CLOUD DATABASE(VPC) Created 상태"
                },
                "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"
                },
                "cloudHadoopNotebookServerInstanceList": [
                    {
                        "cloudHadoopNotebookServerInstanceNo": 1000*****,
                        "cloudHadoopNotebookServerName": "n-001-hd-nt2-5uln-hd",
                        "cloudHadoopNotebookServerRole": {
                            "code": "N",
                            "codeName": "Notebook Node"
                        },
                        "cloudHadoopNotebookServerInstanceStatusName": "running",
                        "cloudHadoopNotebookServerInstanceStatus": {
                            "code": "RUN",
                            "codeName": "CLOUD DATABASE(VPC) 서버 Running 상태"
                        },
                        "cloudHadoopNotebookServerInstanceOperation": {
                            "code": "NOOP",
                            "codeName": "CLOUD DATABASE(VPC) 서버 Null OP"
                        },
                        "regionCode": "KR",
                        "zoneCode": "KR-2",
                        "vpcNo": "7****",
                        "subnetNo": "17****",
                        "cpuCount": 4,
                        "memorySize": 17179869184,
                        "dataStorageSize": 107374182400
                    }
                ]
            }
        ],
        "requestId": "f0748aa3-****-****-****-397bfb97e6d6",
        "returnCode": "0",
        "returnMessage": "success"
    }
}
```