getCloudHadoopNotebookInstanceList

Prev Next

VPC環境で利用できます。

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

構文

getCloudHadoopNotebookInstanceList構文は次の通りです。

./ncloud vhadoop getCloudHadoopNotebookInstanceList \
    [--zoneCode <zone-code>] \
    [--vpcNo <vpc-no>] \
    [--subnetNo <subnet-no>] \
    [--cloudHadoopNotebookName <notebook-name>] \
    [--cloudHadoopNotebookInstanceNoList <notebook-instance-no-list>] \
    [--cloudHadoopNotebookServerName <notebook-server-name>] \
    [--cloudHadoopNotebookServerInstanceNoList <notebook-server-instance-no-list>] \
    [--pageNo <page-no>] \
    [--pageSize <page-size>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

オプション

getCloudHadoopNotebookInstanceListの実行時に指定できるオプションについて説明します。

必須オプション

getCloudHadoopNotebookInstanceListの必須オプションです。

オプション タイプ 必須の有無 説明
--pageSize Integer Conditional ページ出力数
  • 1~N
  • pageNo入力時、必ず入力

任意オプション

getCloudHadoopNotebookInstanceListの任意オプションです。指定しない場合、オプションにはデフォルト値が適用されます。

オプション タイプ 必須の有無 説明
--zoneCode String Optional ゾーンコード
--vpcNo String Optional VPC番号
--subnetNo String Optional Subnet番号
--cloudHadoopNotebookName String Optional ノートブック名
--cloudHadoopNotebookInstanceNoList List Optional ノートブックインスタンス番号リスト
  • スペースで区切って複数入力可能 (例: --cloudHadoopNotebookInstanceNoList 1234 2345)
--cloudHadoopNotebookServerName String Optional ノートブックノードサーバ名
--cloudHadoopNotebookServerInstanceNoList List Optional ノートブックノードサーバインスタンス番号リスト
  • スペースで区切って複数入力可能 (例: --cloudHadoopNotebookServerInstanceNoList 1234 2345)
--pageNo Integer Optional ページ番号
  • 0~N (デフォルト: 0)

共通オプション

vhadoopコマンドで共通して使用されるオプションの詳細は、Cloud Hadoop (VPC)のオプションをご参照ください。

例

Cloud Hadoopノートブックリストの照会リクエストが成功すると、各ノートブックの構成情報と状態が返されます。

コマンド

コマンドの例は次の通りです。

./ncloud vhadoop getCloudHadoopNotebookInstanceList \
    --zoneCode KR-2 \
    --vpcNo 12345678 \
    --subnetNo 23456790 \
    --cloudHadoopNotebookName notebook-01 \
    --cloudHadoopNotebookInstanceNoList 34567891 \
    --cloudHadoopNotebookServerName n-001-notebook-01-9dc2-hd \
    --cloudHadoopNotebookServerInstanceNoList 45678910 \
    --pageNo 0 \
    --pageSize 10 \
    --regionCode KR \
    --output json

出力

出力の例は次の通りです。

{
  "getCloudHadoopNotebookInstanceListResponse": {
    "totalRows": 1,
    "cloudHadoopNotebookInstanceList": [
      {
        "cloudHadoopNotebookInstanceNo": "34567891",
        "cloudHadoopNotebookName": "notebook-01",
        "cloudHadoopNotebookImageProductCode": "SW.VCHDP.OS.LNX64.ROCKY.0810.HDNTB.B050",
        "cloudHadoopNotebookInstanceStatusName": "running",
        "cloudHadoopNotebookInstanceStatus": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE(VPC) Created状態"
        },
        "cloudHadoopNotebookInstanceOperation": {
          "code": "NULL",
          "codeName": "CLOUD DATABASE(VPC) Null OP"
        },
        "cloudHadoopNotebookVersion": {
          "code": "NOTEBOOK1.1",
          "codeName": "Notebook 1.1"
        },
        "cloudHadoopNotebookComponent": {
          "code": "NOTEBOOK_1.1",
          "codeName": "Jupyter notebook 6.4.10 , JupyterLab : 3.2.9"
        },
        "cloudHadoopNotebookServerInstanceList": [
          {
            "cloudHadoopNotebookServerInstanceNo": 45678910,
            "cloudHadoopNotebookServerName": "n-001-notebook-01-9dc2-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": "12345678",
            "subnetNo": "23456790",
            "cpuCount": 4,
            "memorySize": 17179869184,
            "dataStorageSize": 107374182400
          }
        ]
      }
    ],
    "requestId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
    "returnCode": "0",
    "returnMessage": "success"
  }
}