---
title: "getCloudHadoopNotebookInstanceList"
slug: "analytics-vhadoop-getcloudhadoopnotebookinstancelist"
tags: ["VPC", "Cloud Hadoop"]
updated: 2026-09-17T09:57:32Z
published: 2026-09-17T09:57:32Z
canonical: "api.ncloud-docs.com/analytics-vhadoop-getcloudhadoopnotebookinstancelist"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.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メソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

### リクエストヘッダ

Cloud Hadoop APIで共通して使用されるヘッダの詳細は、[Cloud Hadoopのリクエストヘッダ](/docs/ja/analytics-vhadoop#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。

### リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `regionCode` | String | Optional | リージョンコード - [getRegionList](/docs/ja/compute-vserver-server-common-getregionlist)を参照 - 照会結果の最初のリージョン(デフォルト) |
| `zoneCode` | String | Optional | ゾーンコードで絞り込み - [getZoneList](/docs/ja/compute-vserver-server-common-getzonelist)を参照 |
| `vpcNo` | String | Optional | VPC番号で絞り込み - [getCloudHadoopTargetVpcList](/docs/ja/analytics-vhadoop-getcloudhadooptargetvpclist)を参照 |
| `subnetNo` | String | Optional | Subnet番号で絞り込み - [getCloudHadoopTargetSubnetList](/docs/ja/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.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/ja/common-vapidatatype-cloudhadoopnotebookinstancelist)を参照 |
| `getCloudHadoopNotebookInstanceListResponse.requestId` | String | - | リクエスト ID - UUID形式 |
| `getCloudHadoopNotebookInstanceListResponse.returnCode` | String | - | レスポンスコード |
| `getCloudHadoopNotebookInstanceListResponse.returnMessage` | String | - | レスポンスメッセージ |

### レスポンスステータスコード

Cloud Hadoop APIで共通して使用されるレスポンスステータスコードの詳細は、[Cloud Hadoopのレスポンスステータスコード](/docs/ja/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"
    }
}
```