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.

createCloudHadoopNotebookInstance

Prev Next

VPC環境で利用できます。

概要

Cloud Hadoop Notebookインスタンスを作成します。

リクエスト

リクエストパラメータ

パラメータ名 必須の有無 タイプ 制限事項 説明
regionCode No String リージョンコード
  • getRegionListアクションを通じて取得可能
  • デフォルト: getRegionList照会結果の最初のリージョンを選択
cloudHadoopNotebookName Yes String 英数字、記号のハイフン「-」、ハングルのみ入力可能
  • 先頭文字と末尾文字には英字(小文字)または数字のみ使用可能
  • 最小: 3
  • 最大: 15
Cloud Hadoop Notebook名
  • 重複使用はできない
cloudHadoopNotebookImageProductCode No String Cloud Hadoop Notebookイメージ商品コード
  • getCloudHadoopNotebookImageProductListアクションの productCodeで取得可能
  • 入力しない場合、デフォルト値で作成
  • デフォルト: Cloud Hadoop Notebookの最新バージョン
cloudHadoopNotebookComponent Yes String Cloud Hadoop Notebook Component
loginKeyName Yes String 認証キー名
  • getCloudHadoopLoginKeyListアクションを通じて取得可能
  • ノードに直接アクセスする際に必要な SSH認証キーを設定
notebookNodeProductCode No String Cloud Hadoop Notebookサーバ商品コード
  • 作成する Cloud Hadoop Notebookインスタンスのサーバスペックを決定
  • getCloudHadoopNotebookProductListアクションの infraResourceDetailTypeCode = 'NTBND'に設定して呼び出すと取得可能
  • デフォルト: 最小スペックが選択される
  • 最小スペックの基準: 1. メモリ 2. CPU
notebookNodeSubnetNo Yes String Notebookノードの Subent番号
  • Notebookノードを配置する Subnetを選択
  • Notebookノードは Private/Public Subnet内に配置
  • notebookNodeSubnetNoはgetCloudHadoopTargetSubnetListアクションを通じて取得可能
bucketName Yes String バケット名
notebookNodeDataStorageTypeCode Yes String CB2 | SSD | HDD Notebookノードのデータストレージタイプコード
  • インストール後にデータストレージタイプは変更不可
  • オプション: CB2 | SSD | HDD
  • getCloudHadoopNotebookImageProductListアクションの generationCode値に応じてデフォルト値が異なる
    • G2: SSD
    • G3: CB2
notebookNodeDataStorageSize Yes Integer
  • 最小: 100
  • 最大: 2000 | 4000 | 6000
Notebookノードのデータストレージ容量
  • 100GB ~ 2000GBまで10GB単位で入力
  • 4000GB、6000GBも使用可能
useNotebookBlockStorage No Boolean Cloud Hadoop Notebookデータストレージの使用有無
  • デフォルト: false
cloudHadoopInstanceNo Yes String Notebookの連携対象の Cloud Hadoopクラスタ番号
engineVersionCode Conditional String エンジンのバージョンコード
  • getCloudHadoopImageProductListを通じて確認
  • Rockyクラスタで作成時にのみ入力、CentOsスペックは無視
  • 入力しない場合、現在提供中の最新バージョンで作成
output No String レスポンス結果の形式タイプ
  • オプション: xml | json
  • デフォルト: 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 createCloudHadoopNotebookInstance --regionCode KR --cloudHadoopNotebookName test*** --cloudHadoopNotebookImageProductCode SW.VCHDP.LNX64.CNTOS.0708.HDNTB.10.B050 --cloudHadoopNotebookComponent NOTEBOOK_COMPONENT_CODE1 --loginKeyName key**** --notebookNodeProductCode SVR.VCHDP.NTBND.STAND.C004.M016.NET.HDD.B050.G002 --notebookNodeSubnetNo 12** --bucketName buc*** --notebookNodeDataStorageTypeCode SSD --notebookNodeDataStorageSize 100 --useNotebookBlockStorage true --cloudHadoopInstanceNo 12**

レスポンス

{
  "createCloudHadoopNotebookInstanceResponse": {
    "totalRows": 1,
    "cloudHadoopNotebookInstanceList": [
      {
        "cloudHadoopNotebookInstanceNo": "2766154",
        "cloudHadoopNotebookName": "test12",
        "cloudHadoopNotebookImageProductCode": "SW.VCHDP.LNX64.CNTOS.0708.HDNTB.10.B050",
        "cloudHadoopNotebookInstanceStatusName": "creating",
        "cloudHadoopNotebookInstanceStatus": {
          "code": "INIT",
          "codeName": "CLOUD DATABASE(VPC) Init State"
        },
        "cloudHadoopNotebookInstanceOperation": {
          "code": "CREAT",
          "codeName": "CLOUD DATABASE(VPC) Creat OP"
        },
        "cloudHadoopNotebookVersion": {
          "code": "NOTEBOOK1.0",
          "codeName": "Notebook 1.0"
        },
        "cloudHadoopNotebookComponent": {
          "code": "NOTEBOOK_1.0",
          "codeName": "Jupyter notebook 6.4.10 , JupyterLab : 3.2.9"
        },
        "createDate": "2023-02-07T20:40:50+0900",
        "loginKey": "newkey",
        "objectStorageBucket": "aabbcc",
        "accessControlGroupNoList": [],
        "cloudHadoopClusterName": "fsdfds",
        "clusterDirectAccessAccount": "sshuser",
        "useNotebookBlockStorage": true,
        "cloudHadoopNotebookServerInstanceList": [
          {
            "cloudHadoopNotebookServerName": "n-001-test12-15dk-hd",
            "cloudHadoopNotebookServerInstanceStatusName": "creating",
            "cloudHadoopNotebookServerInstanceStatus": {
              "code": "PEND",
              "codeName": "CLOUD DATABASE(VPC) Server Pending State"
            },
            "cloudHadoopNotebookServerInstanceOperation": {
              "code": "CREAT",
              "codeName": "CLOUD DATABASE(VPC) Server Create OP"
            },
            "cloudHadoopNotebookServerRole": {
              "code": "N",
              "codeName": "Notebook Node"
            }, 
            "cloudHadoopNotebookProductCode": "SVR.VCHDP.NTBND.STAND.C004.M016.NET.HDD.B050.G002",
            "regionCode": "KR",
            "zoneCode": "KR-2",
            "vpcNo": "3977",
            "subnetNo": "5747",
            "cpuCount": 4,
            "memorySize": 17179869184,
            "dataStorageSize": 107374182400,
            "isPublicSubnet": false,
            "dataStorageType": {
              "code": "SSD",
              "codeName": "SSD"
             },
            "createDate": "2023-02-07T20:40:50+0900"
          }
        ]
      }
    ],
    "requestId": "9a425589-09e1-4202-94df-f2102dcca882",
    "returnCode": "0",
    "returnMessage": "success"
  }
}
<createCloudHadoopNotebookInstanceResponse>
  <requestId>ff98794d-34b7-42ac-8154-14b7afa479cb</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <cloudHadoopNotebookInstanceList>
    <cloudHadoopNotebookInstance>
      <cloudHadoopNotebookInstanceNo>2766068</cloudHadoopNotebookInstanceNo>
      <cloudHadoopNotebookName>test123</cloudHadoopNotebookName>
      <cloudHadoopNotebookImageProductCode>SW.VCHDP.LNX64.CNTOS.0708.HDNTB.10.B050</cloudHadoopNotebookImageProductCode>
      <cloudHadoopNotebookInstanceStatusName>creating</cloudHadoopNotebookInstanceStatusName>
      <cloudHadoopNotebookInstanceStatus>
        <code>INIT</code>
        <codeName>CLOUD DATABASE(VPC) Init State</codeName>
      </cloudHadoopNotebookInstanceStatus>
      <cloudHadoopNotebookInstanceOperation>
        <code>CREAT</code>
        <codeName>CLOUD DATABASE(VPC) Creat 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>
      <createDate>2023-02-07T20:16:55+0900</createDate>
      <loginKey>newkey</loginKey>
      <objectStorageBucket>aabbcc</objectStorageBucket>
      <accessControlGroupNoList/>
      <cloudHadoopClusterName>fsdfds</cloudHadoopClusterName>
      <clusterDirectAccessAccount>sshuser</clusterDirectAccessAccount>
      <useNotebookBlockStorage>true</useNotebookBlockStorage>
      <cloudHadoopNotebookServerInstanceList>
        <cloudHadoopNotebookServerInstance>
          <cloudHadoopNotebookServerName>n-001-test123-15d8-hd</cloudHadoopNotebookServerName>
          <cloudHadoopNotebookServerInstanceStatusName>creating</cloudHadoopNotebookServerInstanceStatusName>
          <cloudHadoopNotebookServerInstanceStatus>
            <code>PEND</code>
            <codeName>CLOUD DATABASE(VPC) Server Pending State</codeName>
          </cloudHadoopNotebookServerInstanceStatus>
          <cloudHadoopNotebookServerInstanceOperation>
            <code>CREAT</code>
            <codeName>CLOUD DATABASE(VPC) Server Create OP</codeName>
          </cloudHadoopNotebookServerInstanceOperation>
          <cloudHadoopNotebookServerRole>
            <code>N</code>
            <codeName>Notebook Node</codeName>
          </cloudHadoopNotebookServerRole> 
          <cloudHadoopNotebookProductCode>SVR.VCHDP.NTBND.STAND.C004.M016.NET.HDD.B050.G002</cloudHadoopNotebookProductCode>
          <regionCode>KR</regionCode>
          <zoneCode>KR-2</zoneCode>
          <vpcNo>3977</vpcNo>
          <subnetNo>5747</subnetNo>
          <cpuCount>4</cpuCount>
          <memorySize>17179869184</memorySize>
          <dataStorageSize>107374182400</dataStorageSize>
          <isPublicSubnet>false</isPublicSubnet>
          <dataStorageType>
    <code>SSD</code>
    <codeName>SSD</codeName>
</dataStorageType> 
          <createDate>2023-02-07T20:16:55+0900</createDate>
        </cloudHadoopNotebookServerInstance>
      </cloudHadoopNotebookServerInstanceList>
    </cloudHadoopNotebookInstance>
  </cloudHadoopNotebookInstanceList>
</createCloudHadoopNotebookInstanceResponse>