getCloudHadoopNotebookInstanceList

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in VPC

Overview

Searches Cloud Hadoop Notebook instance list.

Requests

Request parameters

Parameter name	Requirement status	Type	Restrictions	Description
regionCode	No	String		Region code - Can be obtained through the getRegionList action - Default: select the first Region of the getRegionList search results
zoneCode	No	String		Zone code - Can determine the Zone where the Cloud Hadoop Notebook instance list will be searched - Can be obtained through the getZoneList action
vpcNo	No	String		VPC number - Can determine the VPC where the Cloud Hadoop Notebook instance list will be searched - Can be obtained through the getCloudHadoopTargetVpcList action
subnetNo	No	String		Subnet number - Can determine the Subnet where the Cloud Hadoop Notebook instance list will be searched - Can be obtained through the getCloudHadoopTargetSubnetList action
cloudHadoopNotebookName	No	String		Cloud Hadoop Notebook name - Can search by filtering with Cloud Hadoop Notebook name - Can be obtained through the getCloudHadoopNotebookInstanceList action
cloudHadoopNotebookInstanceNoList	No	List<String>		Cloud Hadoop Notebook instance number list - Can search by filtering with Cloud Hadoop Notebook instance number - Can be obtained through the getCloudHadoopNotebookInstanceList action <example> cloudHadoopNotebookInstanceNoList.1=1234&cloudHadoopNotebookInstanceNoList.2=2345
cloudHadoopNotebookServerName	No	String		Cloud Hadoop Notebook server name - Can search by filtering with Cloud Hadoop Notebook server name - Can be obtained through the getCloudHadoopNotebookInstanceList action
cloudHadoopNotebookServerInstanceNoList	No	List<String>		Cloud Hadoop Notebook server instance number list - Can search by filtering with Cloud Hadoop Notebook server instance number - Can be obtained through the getCloudHadoopNotebookInstanceList action <example> cloudHadoopNotebookServerInstanceNoList.1=1234&cloudHadoopNotebookServerInstanceNoList.2=2345
pageNo	No	Integer	Min: 0	Page number of the paged results - Can page the result values using pageNo and pageSize
pageSize	Conditional	Integer	Min: 1	Size of each page to be displayed when paging - Can page the result values using pageNo and pageSize - Must enter when entering pageNo
output	No	String		Format type of response result - Options: xml \| json Default: xml

Responses

Response data type

CloudHadoopNotebookInstanceList type

CloudHadoopNotebookInstanceList extends CommonResponse
private Integer totalRows;
private List<CloudHadoopNotebookInstance> cloudHadoopNotebookInstanceList = new ArrayList<>();

CloudHadoopNotebookInstance
private String cloudHadoopNotebookInstanceNo;
private String cloudHadoopNotebookName;
private String cloudHadoopNotebookInstanceStatusName;
private CommonCode cloudHadoopNotebookInstanceStatus;
private CommonCode cloudHadoopNotebookInstanceOperation;
private CloudHadoopNotebookComponent cloudHadoopNotebookComponent;
private CloudHadoopNotebookVersion cloudHadoopNotebookVersion;
private String clusterDirectAccessAccount;
private String loginKey;
private String objectStorageBucket;
private String cloudHadoopNotebookImageProductCode;
private String domain;
private AccessControlGroupNoList accessControlGroupNoList;
private Date createDate;
private String cloudHadoopClusterName;
private Boolean useNotebookBlockStorage;
private List<CloudHadoopNotebookServerInstance> cloudHadoopNotebookServerInstanceList;

CloudHadoopNotebookComponent
private String code;
private String codeName;

CloudHadoopNotebookVersion
private String code;
private String codeName;

AccessControlGroupNoList
private List<String> accessControlGroupNoList = new ArrayList<>();

CloudHadoopNotebookServerInstance
private String cloudHadoopNotebookServerInstanceNo;
private String cloudHadoopNotebookServerName;
private String cloudHadoopNotebookServerInstanceStatusName;
private CommonCode cloudHadoopNotebookServerInstanceStatus;
private CommonCode cloudHadoopNotebookServerInstanceOperation;
private CommonCode cloudHadoopNotebookServerRole;
private String regionCode;
private String vpcNo;
private String subnetNo;
private Date createDate;
private Date uptime;
private String zoneCode;
private Long memorySize;
private Integer cpuCount;
private Boolean isPublicSubnet;
private Long dataStorageSize;
private String cloudHadoopNotebookProductCode;
private CommonCode dataStorageType;

Examples

Call

ncloud vhadoop getCloudHadoopNotebookInstanceList --regionCode KR --zoneCode KR-1 --vpcNo ***87 --subnetNo ***32 --cloudHadoopNotebookName test-**** --cloudHadoopNotebookInstanceNoList.1 178**** --cloudHadoopNotebookServerName test-**** --cloudHadoopServerNotebookInstanceNoList.1 1781*** --pageNo 0 --pageSize 10

Responses

{
  "getCloudHadoopNotebookInstanceListResponse": {
    "totalRows": 1,
    "cloudHadoopNotebookInstanceList": [
      {
        "cloudHadoopNotebookInstanceNo": "2766154",
        "cloudHadoopNotebookName": "test12",
        "cloudHadoopNotebookImageProductCode": "SW.VCHDP.LNX64.CNTOS.0708.HDNTB.10.B050",
        "cloudHadoopNotebookInstanceStatusName": "running",
        "cloudHadoopNotebookInstanceStatus": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE(VPC) Created State"
        },
        "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": 2766155,
            "cloudHadoopNotebookServerName": "n-001-test12-15dk-hd",
            "cloudHadoopNotebookServerInstanceStatusName": "running",
            "cloudHadoopNotebookServerInstanceStatus": {
              "code": "RUN",
              "codeName": "CLOUD DATABASE(VPC) Server Running State"
            },
            "cloudHadoopNotebookServerInstanceOperation": {
              "code": "NOOP",
              "codeName": "CLOUD DATABASE(VPC) Server Null OP"
            },
            "cloudHadoopNotebookServerRole": {
              "code": "N",
              "codeName": "Notebook Node"
            },
            "regionCode": "KR",
            "zoneCode": "KR-2",
            "vpcNo": "3977",
            "subnetNo": "5747",
            "cpuCount": 4,
            "memorySize": 17179869184,
            "dataStorageSize": 107374182400
          }
        ]
      }
    ],
    "requestId": "182ae8cd-1c30-4618-9954-e4517a88aeb8",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

<getCloudHadoopNotebookInstanceListResponse>
  <requestId>4e1ac8f5-b411-474b-83fb-7814aa1c1a7e</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <cloudHadoopNotebookInstanceList>
    <cloudHadoopNotebookInstance>
      <cloudHadoopNotebookInstanceNo>2766154</cloudHadoopNotebookInstanceNo>
      <cloudHadoopNotebookName>test12</cloudHadoopNotebookName>
      <cloudHadoopNotebookImageProductCode>SW.VCHDP.LNX64.CNTOS.0708.HDNTB.10.B050</cloudHadoopNotebookImageProductCode>
      <cloudHadoopNotebookInstanceStatusName>running</cloudHadoopNotebookInstanceStatusName>
      <cloudHadoopNotebookInstanceStatus>
        <code>CREAT</code>
        <codeName>CLOUD DATABASE(VPC) Created State</codeName>
      </cloudHadoopNotebookInstanceStatus>
      <cloudHadoopNotebookInstanceOperation>
        <code>NULL</code>
        <codeName>CLOUD DATABASE(VPC) Null OP</codeName>
      </cloudHadoopNotebookInstanceOperation>
        <cloudHadoopNotebookVersion>
          <code>NOTEBOOK1.0</code>
          <codeName>Notebook 1.0</codeName>
      </cloudHadoopNotebookVersion>
      <cloudHadoopNotebookComponent>
        <code>NOTEBOOK_COMPONENT_CODE1</code>
        <codeName>Jupyter notebook 6.4.10 , JupyterLab : 3.2.9</codeName>
      </cloudHadoopNotebookComponent>
      <cloudHadoopNotebookServerInstanceList>
        <cloudHadoopNotebookServerInstance>
          <cloudHadoopNotebookServerInstanceNo>2766155</cloudHadoopNotebookServerInstanceNo>
          <cloudHadoopNotebookServerName>n-001-test12-15dk-hd</cloudHadoopNotebookServerName>
          <cloudHadoopNotebookServerInstanceStatusName>running</cloudHadoopNotebookServerInstanceStatusName>
          <cloudHadoopNotebookServerInstanceStatus>
            <code>RUN</code>
            <codeName>CLOUD DATABASE(VPC) Server Running State</codeName>
          </cloudHadoopNotebookServerInstanceStatus>
          <cloudHadoopNotebookServerInstanceOperation>
            <code>NOOP</code>
            <codeName>CLOUD DATABASE(VPC) Server Null OP</codeName>
          </cloudHadoopNotebookServerInstanceOperation>
          <cloudHadoopNotebookServerRole>
            <code>N</code>
            <codeName>Notebook Node</codeName>
          </cloudHadoopNotebookServerRole>
          <regionCode>KR</regionCode>
          <zoneCode>KR-2</zoneCode>
          <vpcNo>3977</vpcNo>
          <subnetNo>5747</subnetNo>
          <cpuCount>4</cpuCount>
          <memorySize>17179869184</memorySize>
          <dataStorageSize>107374182400</dataStorageSize>
        </cloudHadoopNotebookServerInstance>
      </cloudHadoopNotebookServerInstanceList>
    </cloudHadoopNotebookInstance>
  </cloudHadoopNotebookInstanceList>
</getCloudHadoopNotebookInstanceListResponse>

Was this article helpful?

What's Next

getCloudHadoopNotebookProductList

Table of contents

Overview
Requests
Responses
Examples