getCloudHadoopNotebookInstanceList

Available in VPC

Get the list of Cloud Hadoop notebooks.

Syntax

The getCloudHadoopNotebookInstanceList syntax is as follows:

./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>]

Options

This section describes the options available when running getCloudHadoopNotebookInstanceList.

Required options

The following options are required for getCloudHadoopNotebookInstanceList.

Options	Type	Required	Description
`--pageSize`	Integer	Conditional	Page output count `1`-N Required when entering `pageNo`

Optional options

These are the optional options for getCloudHadoopNotebookInstanceList. Options that are not specified will use their default values.

Options	Type	Required	Description
`--zoneCode`	String	Optional	Zone code See getZoneList.
`--vpcNo`	String	Optional	VPC number See getCloudHadoopTargetVpcList.
`--subnetNo`	String	Optional	Subnet number See getCloudHadoopTargetSubnetList.
`--cloudHadoopNotebookName`	String	Optional	Notebook name
`--cloudHadoopNotebookInstanceNoList`	List	Optional	Notebook instance ID list You can enter multiple items separated by spaces (e.g., `--cloudHadoopNotebookInstanceNoList 1234 2345`).
`--cloudHadoopNotebookServerName`	String	Optional	Notebook node server name
`--cloudHadoopNotebookServerInstanceNoList`	List	Optional	Notebook node server instance ID list You can enter multiple items separated by spaces (e.g., `--cloudHadoopNotebookServerInstanceNoList 1234 2345`).
`--pageNo`	Integer	Optional	Page number `0`-N (default: `0`)

Common options

For information about the options common to all vhadoop subcommands, see Cloud Hadoop (VPC) options.

Examples

If the request to retrieve the list of Cloud Hadoop notebooks is successful, the configuration information and status of each notebook are returned.

Command

The command example is as follows:

./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

Output

The output example is as follows:

{
  "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 status"
        },
        "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) server Running status"
            },
            "cloudHadoopNotebookServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE (VPC) server 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"
  }
}