createCloudHadoopNotebookInstance

Prev Next

VPC環境で利用できます。

Cloud Hadoopノートブックを作成します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET | POST /vhadoop/v2/createCloudHadoopNotebookInstance
参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

Cloud Hadoop APIで共通して使用されるヘッダの詳細は、Cloud Hadoopのリクエストヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
cloudHadoopNotebookName String Required ノートブック名
  • 英字の小文字、数字、記号の「-」を組み合わせて3~15文字以内で入力
  • 文字列の先頭文字は英文字の小文字、末尾文字は英文字の小文字または数字のみ使用
cloudHadoopNotebookComponent String Required ノートブックコンポーネント
cloudHadoopNotebookImageProductCode String Optional ノートブックのイメージコード
cloudHadoopInstanceNo String Required クラスタインスタンス番号
bucketName String Required Object Storageバケット名
notebookNodeSubnetNo String Required ノートブックノードの Subnet番号
notebookNodeProductCode String Optional ノートブックノードのサーバタイプコード
useNotebookBlockStorage Boolean Optional ノートブックノードにストレージを追加するかどうか
  • true | false (デフォルト)
    • true: 追加
    • false: 追加しない
notebookNodeDataStorageTypeCode String Conditional ストレージタイプ
  • SSD (デフォルト) | HDD
  • useNotebookBlockStorageがtrueの場合、必ず入力
  • この後は変更不可
notebookNodeDataStorageSize Integer Conditional ストレージ容量(GB)
  • 100~2000 (10GB単位) | 4000 | 6000
  • useNotebookBlockStorageがtrueの場合、必ず入力
loginKeyName String Required 認証キー名
engineVersionCode String Optional エンジンのバージョンコード
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vhadoop/v2/createCloudHadoopNotebookInstance?regionCode=KR&cloudHadoopNotebookName=hd-nt1&cloudHadoopNotebookComponent=NOTEBOOK_1.0&cloudHadoopInstanceNo=2707****&bucketName=bk1&notebookNodeSubnetNo=17****&loginKeyName=**********&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
createCloudHadoopNotebookInstanceResponse Object - レスポンスの結果
createCloudHadoopNotebookInstanceResponse.requestId String - リクエスト ID
  • UUID形式
createCloudHadoopNotebookInstanceResponse.returnCode String - レスポンスコード
createCloudHadoopNotebookInstanceResponse.returnMessage String - レスポンスメッセージ

レスポンスステータスコード

Cloud Hadoop APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud Hadoopのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "createCloudHadoopNotebookInstanceResponse": {
        "totalRows": 1,
        "cloudHadoopNotebookInstanceList": [
            {
                "cloudHadoopNotebookInstanceNo": "1000*****",
                "cloudHadoopNotebookName": "hd-nt2",
                "cloudHadoopNotebookImageProductCode": "SW.VCHDP.LNX64.CNTOS.0708.HDNTB.10.B050",
                "cloudHadoopNotebookInstanceStatusName": "creating",
                "cloudHadoopNotebookInstanceStatus": {
                    "code": "INIT",
                    "codeName": "CLOUD DATABASE(VPC) Init状態"
                },
                "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": "2025-02-20T10:55:49+0900",
                "loginKey": "**********",
                "objectStorageBucket": "bk1",
                "accessControlGroupNoList": [],
                "cloudHadoopClusterName": "clus1",
                "clusterDirectAccessAccount": "sshuser",
                "cloudHadoopNotebookServerInstanceList": [
                    {
                        "cloudHadoopNotebookServerName": "n-001-hd-nt2-5uln-hd",
                        "cloudHadoopNotebookServerRole": {
                            "code": "N",
                            "codeName": "Notebook Node"
                        },
                        "cloudHadoopNotebookServerInstanceStatusName": "creating",
                        "cloudHadoopNotebookServerInstanceStatus": {
                            "code": "PEND",
                            "codeName": "CLOUD DATABASE(VPC)サーバ Pending状態"
                        },
                        "cloudHadoopNotebookServerInstanceOperation": {
                            "code": "CREAT",
                            "codeName": "CLOUD DATABASE(VPC)サーバ Create OP"
                        },
                        "cloudHadoopNotebookProductCode": "SVR.VCHDP.NTBND.STAND.C004.M016.NET.HDD.B050.G002",
                        "regionCode": "KR",
                        "zoneCode": "KR-2",
                        "vpcNo": "7****",
                        "subnetNo": "17****",
                        "cpuCount": 4,
                        "memorySize": 17179869184,
                        "dataStorageSize": 107374182400,
                        "isPublicSubnet": true,
                        "createDate": "2025-02-20T10:55:49+0900"
                    }
                ]
            }
        ],
        "requestId": "f3cc51e1-****-****-****-bbb30124e1da",
        "returnCode": "0",
        "returnMessage": "success"
    }
}