Documentation Index

Fetch the complete documentation index at: https://cli.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>