Documentation Index

Fetch the complete documentation index at: https://cli-gov.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

getCloudHadoopNotebookInstanceList

Prev Next

VPC 환경에서 이용 가능합니다.

개요

Cloud Hadoop Notebook 인스턴스 리스트를 조회합니다.

요청

요청 파라미터

파라미터명 필수 여부 타입 제약 사항 설명
regionCode No String 리전 코드
- getRegionList 액션을 통해 획득 가능
- Default: getRegionList 조회 결과의 첫 번째 리전 선택
zoneCode No String ZONE 코드
- Cloud Hadoop Notebook 인스턴스 리스트가 조회될 Zone 결정 가능
- getZoneList 액션을 통해 획득 가능
vpcNo No String VPC 번호
- Cloud Hadoop Notebook 인스턴스 리스트가 조회될 VPC 결정 가능
- getCloudHadoopTargetVpcList 액션을 통해 획득 가능
subnetNo No String Subnet 번호
- Cloud Hadoop Notebook 인스턴스 리스트가 조회될 Subnet 결정 가능
- getCloudHadoopTargetSubnetList 액션을 통해 획득 가능
cloudHadoopNotebookName No String Cloud Hadoop Notebook 이름
- Cloud Hadoop Notebook 이름으로 필터링하여 검색 가능
- getCloudHadoopNotebookInstanceList 액션을 통해 획득 가능
cloudHadoopNotebookInstanceNoList No List<String> Cloud Hadoop Notebook 인스턴스 번호 리스트
- Cloud Hadoop Notebook 인스턴스 번호로 필터링하여 검색 가능
- getCloudHadoopNotebookInstanceList 액션을 통해 획득 가능
<예시> cloudHadoopNotebookInstanceNoList.1=1234&cloudHadoopNotebookInstanceNoList.2=2345
cloudHadoopNotebookServerName No String Cloud Hadoop Notebook 서버 이름
- Cloud Hadoop Notebook 서버 이름으로 필터링하여 검색 가능
- getCloudHadoopNotebookInstanceList 액션을 통해 획득 가능
cloudHadoopNotebookServerInstanceNoList No List<String> Cloud Hadoop Notebook 서버 인스턴스 번호 리스트
- Cloud Hadoop Notebook 서버 인스턴스 번호로 필터링하여 검색 가능
- getCloudHadoopNotebookInstanceList 액션을 통해 획득 가능
<예시> cloudHadoopNotebookServerInstanceNoList.1=1234&cloudHadoopNotebookServerInstanceNoList.2=2345
pageNo No Integer Min: 0 페이징된 결과의 페이지 번호
- 결괏값을 pageNo, pageSize를 이용하여 페이징 처리 가능
pageSize Conditional Integer Min: 1 페이징 시 보여줄 각 페이지 사이즈
- 결괏값을 pageNo, pageSize를 이용하여 페이징 처리 가능
- pageNo 입력 시 입력 필수
output No String 응답 결과의 포맷 타입
- Options: xml | json
Default: xml

응답

응답 데이터 타입

  • CloudHadoopNotebookInstanceList 타입
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;

예시

호출

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

응답

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