getCloudHadoopNotebookInstanceList

Prev Next

VPC環境で利用できます。

Cloud Hadoopノートブックリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET | POST /vhadoop/v2/getCloudHadoopNotebookInstanceList
参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

Cloud Hadoop APIで共通して使用されるヘッダの詳細は、Cloud Hadoopのリクエストヘッダをご参照ください。

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
zoneCode String Optional ゾーンコードで絞り込み
vpcNo String Optional VPC番号で絞り込み
subnetNo String Optional Subnet番号で絞り込み
cloudHadoopNotebookName String Optional ノートブック名で絞り込み
cloudHadoopNotebookInstanceNoList Array Optional ノートブックインスタンス番号リスト
  • ノートブックインスタンス番号で絞り込み
  • <例> cloudHadoopNotebookInstanceNoList.1=1234&cloudHadoopNotebookInstanceNoList.2=2345
cloudHadoopNotebookServerName String Optional ノートブックノードサーバ名で絞り込み
cloudHadoopNotebookServerInstanceNoList Array Optional ノートブックノードサーバインスタンス番号リスト
  • ノートブックノードサーバインスタンス番号で絞り込み
  • <例> cloudHadoopNotebookServerInstanceNoList.1=1234&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 - レスポンスの結果
getCloudHadoopNotebookInstanceListResponse.requestId String - リクエスト ID
  • UUID形式
getCloudHadoopNotebookInstanceListResponse.returnCode String - レスポンスコード
getCloudHadoopNotebookInstanceListResponse.returnMessage String - レスポンスメッセージ

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

Cloud Hadoop APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud Hadoopのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "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"
    }
}