createCloudHadoopInstance

Prev Next

VPC環境で利用できます。

Cloud Hadoopクラスタを作成します。

リクエスト

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

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

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
cloudHadoopClusterName String Required クラスタ名
  • 英字の小文字、数字、記号の「-」を組み合わせて3~15文字以内で入力
  • 文字列の先頭文字は英字の小文字、末尾文字は英字の小文字または数字のみ使用
  • 重複使用不可
cloudHadoopImageProductCode String Optional クラスタイメージコード
cloudHadoopClusterTypeCode String Required クラスタタイプコード
cloudHadoopAddOnCodeList Array Optional クラスタ Add-onコンポーネントリスト
  • getCloudHadoopAddOnListを参照
  • Cloud Hadoop 1.5以降のバージョンで適用可能
  • <例> cloudHadoopAddOnCodeList.1=PRESTO&cloudHadoopAddOnCodeList.2=HBASE
useDataCatalog Boolean Optional Data Catalogサービスの使用有無
  • true | false (デフォルト)
    • true: 使用。Hive メタストアを Data Catalogサービスのカタログを通じて提供
    • false: 使用しない
  • 使用条件
    • Data Catalogサービスの申し込みと正常なの運用状態
    • Cloud Hadoop 2.0以降のバージョン
useKdc Boolean Optional Kerberos認証設定を使用するかどうか
  • true | false (デフォルト)
    • true: 使用
    • false: 使用しない
  • 使用する場合、マスターノードに KDCサーバの冗長性を提供
kdcRealm String Conditional KDC Realm情報
  • useKdcがtrueの場合、必ず入力
  • Realm形式のドメインルールのみ許可
kdcPassword String Conditional KDC管理者アカウントのパスワード
  • useKdcがtrueの場合、必ず入力
  • 英数字、記号を組み合わせて8~20文字以内で入力
  • 使用できない記号: '、"、₩、/、&、`、スペース
vpcNo String Required VPC番号
cloudHadoopAdminUserName String Required クラスタ管理者アカウントのユーザー名
  • 英語の小文字、数字、記号の「-」を組み合わせて3~15文字以内で入力
  • 文字列の先頭文字は英字の小文字、末尾文字は英字の小文字または数字のみ使用
  • Ambariコンソール接続時に必要
cloudHadoopAdminUserPassword String Required クラスタ管理者アカウントのパスワード
  • 英数字、記号を組み合わせて8~20文字以内で入力
  • 使用できない記号: '、"、¥、/、&、`、スペース
  • Ambariコンソール接続時に必要
bucketName String Required Object Storageのバケット名
useBootstrapScript Boolean Optional ブートストラップスクリプトを使用するかどうか
  • true | false (デフォルト)
    • true: 使用
    • false: 使用しない
  • 使用する場合、すべてのノードでスクリプトを事前に実行
bootstrapScript String Conditional ブートストラップスクリプト
  • useBootstrapScriptがtrueの場合、必ず入力
  • バケット内のフォルダとファイル名を入力
  • クラスタと連携されているバケットでのみスクリプトを実行できる
  • ファイル名は英字のみ使用可能。スペース、記号は使用不可
  • スクリプトの長さ: N~1,024Bytes
edgeNodeSubnetNo String Required エッジノードの Subnet番号
edgeNodeProductCode String Optional エッジノードのサーバタイプコード
masterNodeSubnetNo String Required マスターノードの Subnet番号
masterNodeProductCode String Optional マスターノードのサーバタイプコード
masterNodeDataStorageTypeCode String Required マスターノードのストレージタイプ
  • SSD (デフォルト) | HDD
  • インストール後は変更不可
masterNodeDataStorageSize Integer Required マスターノードのストレージ容量(GB)
  • 100~2000 (10GB単位) | 4000 | 6000
workerNodeSubnetNo String Required ワーカーノードの Subnet番号
workerNodeProductCode String Optional ワーカーノードのサーバタイプコード
workerNodeCount Integer Optional ワーカーノード数
  • 2~8 (デフォルト: 2)
workerNodeDataStorageTypeCode String Required ワーカーノードのストレージタイプ
  • SSD (デフォルト) | HDD
  • インストール後は変更不可
workerNodeDataStorageSize Integer Required ワーカーノードのストレージ容量(GB)
  • 100~2000 (10GB単位) | 4000 | 6000
loginKeyName String Required 認証キー名
engineVersionCode String Optional エンジンのバージョンコード
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json
参考

クラスタのマスターノードとエッジノードの数は個別に設定することはできません。

  • Cloud Hadoopサービスは高可用性(HA)サポートが必須となっているため、クラスタには常に2つのマスターノードが含まれています。
  • エッジノードは1つに固定されています。

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vhadoop/v2/createCloudHadoopInstance?regionCode=KR&cloudHadoopClusterName=cluster03&cloudHadoopClusterTypeCode=CORE_HADOOP_WITH_SPARK&cloudHadoopAddOnCodeList=PRESTO&vpcNo=*****&cloudHadoopAdminUserName=*******&cloudHadoopAdminUserPassword=********&bucketName=bk1&edgeNodeSubnetNo=20****&edgeNodeProductCode=SVR.VCHDP.EDGND.STAND.C004.M016.NET.HDD.B050.G002&masterNodeSubnetNo=20****&masterNodeProductCode=SVR.VCHDP.MSTDT.STAND.C004.M016.NET.HDD.B050.G002&masterNodeDataStorageTypeCode=SSD&masterNodeDataStorageSize=100&workerNodeSubnetNo=20****&workerNodeProductCode=SVR.VCHDP.MSTDT.STAND.C004.M016.NET.HDD.B050.G002&workerNodeCount=2&workerNodeDataStorageTypeCode=SSD&workerNodeDataStorageSize=100&loginKeyName=ncp******&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}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
    "createCloudHadoopInstanceResponse": {
        "totalRows": 1,
        "cloudHadoopInstanceList": [
            {
                "cloudHadoopInstanceNo": "1000*****",
                "cloudHadoopClusterName": "cluster03",
                "cloudHadoopInstanceStatusName": "creating",
                "cloudHadoopInstanceStatus": {
                    "code": "INIT",
                    "codeName": "CLOUD DATABASE(VPC) Init状態"
                },
                "cloudHadoopInstanceOperation": {
                    "code": "CREAT",
                    "codeName": "CLOUD DATABASE(VPC) Creat OP"
                },
                "cloudHadoopClusterType": {
                    "code": "CORE_HADOOP_WITH_SPARK",
                    "codeName": "Core Hadoop with Spark : HDFS(3.1.1), YARN(3.1.1), Zookeeper(3.4.9), Ranger(2.0.0), HIVE(3.1.2), Hue(4.8.0), Zeppelin Notebook(0.10.1), Spark (2.4.8)"
                },
                "cloudHadoopVersion": {
                    "code": "HADOOP2.1",
                    "codeName": "Cloud Hadoop 2.1"
                },
                "cloudHadoopAddOnList": [],
                "ambariServerHost": "e-001-cluster03-5v3z-hd",
                "clusterDirectAccessAccount": "sshuser",
                "loginKey": "**********",
                "objectStorageBucket": "bk1",
                "cloudHadoopImageProductCode": "SW.VCHDP.LNX64.CNTOS.0708.HDP.21.B050",
                "isHa": true,
                "createDate": "2025-02-25T09:24:44+0900",
                "useDataCatalog": false,
                "accessControlGroupNoList": [],
                "cloudHadoopServerInstanceList": [
                    {
                        "cloudHadoopServerName": "e-001-cluster03-5v3z-hd",
                        "cloudHadoopServerRole": {
                            "code": "E",
                            "codeName": "Edge Node"
                        },
                        "cloudHadoopServerInstanceStatusName": "creating",
                        "cloudHadoopServerInstanceStatus": {
                            "code": "PEND",
                            "codeName": "CLOUD DATABASE(VPC)サーバ Pending状態"
                        },
                        "cloudHadoopServerInstanceOperation": {
                            "code": "CREAT",
                            "codeName": "CLOUD DATABASE(VPC)サーバ Create OP"
                        },
                        "cloudHadoopProductCode": "SVR.VCHDP.EDGND.STAND.C004.M016.NET.HDD.B050.G002",
                        "regionCode": "KR",
                        "zoneCode": "KR-2",
                        "vpcNo": "7****",
                       "vpcName": "****",
                        "subnetNo": "20****",
                        "subnetName": "****",
                        "privateIp": "***.***.***.***",
                        "isPublicSubnet": true,
                        "dataStorageSize": 107374182400,
                        "cpuCount": 4,
                        "memorySize": 17179869184,
                        "createDate": "2025-02-25T09:24:44+0900"
                    },
                    {
                        "cloudHadoopServerName": "m-001-cluster03-5v3x-hd",
                        "cloudHadoopServerRole": {
                            "code": "M",
                            "codeName": "Master Node"
                        },
                        "cloudHadoopServerInstanceStatusName": "creating",
                        "cloudHadoopServerInstanceStatus": {
                            "code": "PEND",
                            "codeName": "CLOUD DATABASE(VPC)サーバ Pending状態"
                        },
                        "cloudHadoopServerInstanceOperation": {
                            "code": "CREAT",
                            "codeName": "CLOUD DATABASE(VPC)サーバ Create OP"
                        },
                        "cloudHadoopProductCode": "SVR.VCHDP.MSTDT.STAND.C004.M016.NET.HDD.B050.G002",
                        "regionCode": "KR",
                        "zoneCode": "KR-2",
                        "vpcNo": "7****",
                        "vpcName": "****",
                        "subnetNo": "20****",
                        "subnetName": "****",
                        "privateIp": "***.***.***.***",
                        "isPublicSubnet": false,
                        "dataStorageType": {
                            "code": "SSD",
                            "codeName": "SSD"
                        },
                        "dataStorageSize": 107374182400,
                        "cpuCount": 4,
                        "memorySize": 17179869184,
                        "createDate": "2025-02-25T09:24:44+0900"
                    },
                    {
                        "cloudHadoopServerName": "m-002-cluster03-5v3y-hd",
                        "cloudHadoopServerRole": {
                            "code": "M",
                            "codeName": "Master Node"
                        },
                        "cloudHadoopServerInstanceStatusName": "creating",
                        "cloudHadoopServerInstanceStatus": {
                            "code": "PEND",
                            "codeName": "CLOUD DATABASE(VPC)サーバ Pending状態"
                        },
                        "cloudHadoopServerInstanceOperation": {
                            "code": "CREAT",
                            "codeName": "CLOUD DATABASE(VPC)サーバ Create OP"
                        },
                        "cloudHadoopProductCode": "SVR.VCHDP.MSTDT.STAND.C004.M016.NET.HDD.B050.G002",
                        "regionCode": "KR",
                        "zoneCode": "KR-2",
                        "vpcNo": "7****",
                        "vpcName": "****",
                        "subnetNo": "20****",
                        "subnetName": "****",
                        "privateIp": "***.***.***.***",
                        "isPublicSubnet": false,
                        "dataStorageType": {
                            "code": "SSD",
                            "codeName": "SSD"
                        },
                        "dataStorageSize": 107374182400,
                        "cpuCount": 4,
                        "memorySize": 17179869184,
                        "createDate": "2025-02-25T09:24:44+0900"
                    },
                    {
                        "cloudHadoopServerName": "d-001-cluster03-5v40-hd",
                        "cloudHadoopServerRole": {
                            "code": "D",
                            "codeName": "Date Node"
                        },
                        "cloudHadoopServerInstanceStatusName": "creating",
                        "cloudHadoopServerInstanceStatus": {
                            "code": "PEND",
                            "codeName": "CLOUD DATABASE(VPC)サーバ Pending状態"
                        },
                        "cloudHadoopServerInstanceOperation": {
                            "code": "CREAT",
                            "codeName": "CLOUD DATABASE(VPC)サーバ Create OP"
                        },
                        "cloudHadoopProductCode": "SVR.VCHDP.MSTDT.STAND.C004.M016.NET.HDD.B050.G002",
                        "regionCode": "KR",
                        "zoneCode": "KR-2",
                        "vpcNo": "7****",
                        "vpcName": "****",
                        "subnetNo": "20****",
                        "subnetName": "****",
                        "privateIp": "***.***.***.***",
                        "isPublicSubnet": false,
                        "dataStorageType": {
                            "code": "SSD",
                            "codeName": "SSD"
                        },
                        "dataStorageSize": 107374182400,
                        "cpuCount": 4,
                        "memorySize": 17179869184,
                        "createDate": "2025-02-25T09:24:44+0900"
                    },
                    {
                        "cloudHadoopServerName": "d-002-cluster03-5v41-hd",
                        "cloudHadoopServerRole": {
                            "code": "D",
                            "codeName": "Date Node"
                        },
                        "cloudHadoopServerInstanceStatusName": "creating",
                        "cloudHadoopServerInstanceStatus": {
                            "code": "PEND",
                            "codeName": "CLOUD DATABASE(VPC)サーバ Pending状態"
                        },
                        "cloudHadoopServerInstanceOperation": {
                            "code": "CREAT",
                            "codeName": "CLOUD DATABASE(VPC)サーバ Create OP"
                        },
                        "cloudHadoopProductCode": "SVR.VCHDP.MSTDT.STAND.C004.M016.NET.HDD.B050.G002",
                        "regionCode": "KR",
                        "zoneCode": "KR-2",
                        "vpcNo": "7****",
                        "vpcName": "****",
                        "subnetNo": "20****",
                        "subnetName": "****",
                        "privateIp": "***.***.***.***",
                        "isPublicSubnet": false,
                        "dataStorageType": {
                            "code": "SSD",
                            "codeName": "SSD"
                        },
                        "dataStorageSize": 107374182400,
                        "cpuCount": 4,
                        "memorySize": 17179869184,
                        "createDate": "2025-02-25T09:24:44+0900"
                    }
                ]
            }
        ],
        "requestId": "86e6bc28-****-****-****-1b00ebda0d97",
        "returnCode": "0",
        "returnMessage": "success"
    }
}