createCloudHadoopInstance

Classic環境で利用できます。

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

リクエスト

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

メソッド	URI
GET \| POST	/hadoop/v2/createCloudHadoopInstance

参考

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`regionNo`	String	Optional	リージョン番号 `1`: 韓国リージョン(デフォルト) getRegionListを参照
`zoneNo`	String	Optional	ゾーン番号 `3`: KR-2 (デフォルト) getZoneListを参照
`cloudHadoopClusterName`	String	Required	クラスタ名英字の小文字、数字、記号の「-」を組み合わせて3~15文字以内で入力文字列の先頭文字は英字の小文字、末尾文字は英字の小文字または数字のみ使用重複使用不可
`cloudHadoopImageProductCode`	String	Required	クラスタイメージコード getCloudHadoopImageProductListの`productCode`を参照
`cloudHadoopClusterTypeCode`	String	Required	クラスタタイプコード `CHADP` \| `HBASE` \| `SPARK` \| `PRESTO` `CHADP`: Core Hadoop `HBASE`: HBase `SPARK`: Spark `PRESTO`: Presto
`cloudHadoopAdminName`	String	Required	クラスタ管理者アカウントのユーザー名英語の小文字、数字、記号の「-」を組み合わせて3~15文字以内で入力文字列の先頭文字は英字の小文字、末尾文字は英字の小文字または数字のみ使用 Ambariコンソール接続時に必要
`cloudHadoopAdminPassword`	String	Required	クラスタ管理者アカウントのパスワード英数字、記号を組み合わせて8~20文字以内で入力使用できない記号: '、"、¥、/、&、`、スペース Ambariコンソール接続時に必要
`loginKeyName`	String	Required	認証キー名 getLoginKeyListを参照 SSH方法でノードに直接接続する際に必要
`bucketName`	String	Required	Object Storageのバケット名 getCloudHadoopBucketListを参照
`masterNodeProductCode`	String	Required	マスターノードサーバタイプコード getCloudHadoopProductListを参照
`masterNodeCount`	Integer	Optional	マスターノード数 2 (有効値)
`masterNodeStorageTypeCode`	String	Required	マスターノードストレージタイプ `SSD` \| `HDD`
`masterNodeStorageSize`	Integer	Required	マスターノードのストレージ容量(GB) 100~2000(10GB単位)
`workerNodeProductCode`	String	Required	ワーカーノードサーバタイプコード getCloudHadoopProductListを参照
`workerNodeCount`	Integer	Optional	ワーカーノード数 2~8 (デフォルト: 2)
`workerNodeStorageTypeCode`	String	Required	ワーカーノードのストレージタイプ `SSD` \| `HDD`
`workerNodeStorageSize`	Integer	Required	ワーカーノードのストレージ容量(GB) 100~2000(10GB単位)
`edgeNodeProductCode`	String	Conditional	エッジノードサーバタイプコード getCloudHadoopProductListを参照 `cloudHadoopImageProductCode`が`SPSWCHADPLINUX03`の場合、必ず入力
`edgeNodeCount`	String	Conditional	エッジノード数 1(有効値) `cloudHadoopImageProductCode`が`SPSWCHADPLINUX03`の場合、必ず入力
`responseFormatType`	String	Optional	レスポンスデータの形式 `xml`(デフォルト) \| `json`

参考

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

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

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/hadoop/v2/createCloudHadoopInstance?regionNo=1&zoneNo=3&cloudHadoopClusterName=cluster999&cloudHadoopImageProductCode=SPSWCHADPLINUX03&cloudHadoopClusterTypeCode=CHADP&cloudHadoopAdminName=ncpadmin&cloudHadoopAdminPassword=**********&loginKeyName=loginkey000&bucketName=bucket000&masterNodeProductCode=SPSVRCHADP000001&masterNodeCount=2&masterNodeStorageTypeCode=SSD&masterNodeStorageSize=100&workerNodeProductCode=SPSVRCHADP000001&workerNodeCount=2&workerNodeStorageTypeCode=SSD&workerNodeStorageSize=100&edgeNodeProductCode=SPSVRCHADP000010&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}' \
--header 'x-ncp-apigw-api-key: {API Key}'

レスポンス

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

レスポンスボディ

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

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

`createCloudHadoopInstanceResponse.cloudHadoopInstanceList`

createCloudHadoopInstanceResponse.cloudHadoopInstanceListの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`cloudHadoopInstanceNo`	String	-	クラスタインスタンス番号
`cloudHadoopClusterName`	String	-	クラスタ名
`cloudHadoopImageProductCode`	String	-	クラスタイメージコード
`cloudHadoopClusterType`	Object	-	クラスタタイプ情報
`cloudHadoopClusterType.code`	String	-	クラスタタイプコード `CHADP` \| `HBASE` \| `SPARK` \| `PRESTO` `CHADP`: Core Hadoop `HBASE`: HBase `SPARK`: Spark `PRESTO`: Presto
`cloudHadoopClusterType.codeName`	String	-	クラスタタイプのコード名
`masterNodeCpuCount`	Integer	-	マスターノードの CPU数
`masterNodeCount`	Integer	-	マスターノード数
`masterNodeMemorySize`	Integer	-	マスターノードのメモリ容量(Byte)
`workerNodeCpuCount`	Integer	-	ワーカーノードの CPU数
`workerNodeCount`	Integer	-	ワーカーノード数
`workerNodeMemorySize`	Integer	-	ワーカーノードのメモリ容量(Byte)
`edgeNodeCpuCount`	Integer	-	エッジノードの CPU数
`edgeNodeCount`	Integer	-	エッジノード数
`edgeNodeMemorySize`	Integer	-	エッジノードのメモリ容量(Byte)
`cloudHadoopInstanceStatus`	Object	-	クラスタ状態情報 `cloudHadoopInstanceStatusName`が`creating`の場合、表示
`cloudHadoopInstanceStatus.code`	String	-	クラスタの状態コード `INIT`: Cloud Hadoop INIT状態
`cloudHadoopInstanceStatus.codeName`	String	-	クラスタ状態コード名
`cloudHadoopInstanceStatusName`	String	-	クラスタ状態名 `creating` \| `running` \| `settingup` \| `deleting` `creating`: 作成中 `running`: 運用中 `settingup`: 設定中 `deleting`: 削除中
`isHa`	Boolean	-	高可用性をサポートするかどうか `true` (デフォルト) \| `false` `true`: サポート `false`: サポートしない
`zone`	Object	-	ゾーン情報
`zone.zoneNo`	String	-	ゾーン番号
`zone.zoneName`	String	-	ゾーン名
`zone.zoneCode`	String	-	ゾーンコード
`zone.zoneDescription`	String	-	ゾーンの説明
`zone.regionNo`	String	-	リージョン番号
`region`	Object	-	リージョン情報
`region.regionNo`	String	-	リージョン番号
`region.regionCode`	String	-	リージョンコード
`region.regionName`	String	-	リージョン名
`masterNodeServerName`	String	-	マスターノードサーバ名
`createDate`	String	-	クラスタの作成日時 ISO 8601形式
`dataArchitecture`	String	-	データアーキテクチャ
`bucketName`	String	-	Object Storageバケット名
`directConnectionAccount`	String	-	クラスタ直接アクセスアカウント
`loginKeyName`	String	-	認証キー名

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

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

レスポンス例

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

{
    "createCloudHadoopInstanceResponse": {
        "totalRows": 3,
        "cloudHadoopInstanceList": [
            {
                "cloudHadoopInstanceNo": "2777****",
                "cloudHadoopClusterName": "cluster999",
                "cloudHadoopImageProductCode": "SPSWCHADPLINUX03",
                "cloudHadoopClusterType": {
                    "code": "CHADP",
                    "codeName": "Core Hadoop"
                },
                "masterNodeCpuCount": 4,
                "masterNodeCount": 2,
                "masterNodeMemorySize": 8589934592,
                "workerNodeCpuCount": 4,
                "workerNodeCount": 2,
                "workerNodeMemorySize": 8589934592,
                "edgeNodeCpuCount": 4,
                "edgeNodeCount": 1,
                "edgeNodeMemorySize": 8589934592,
                "cloudHadoopInstanceStatus": {
                    "code": "INIT",
                    "codeName": "Cloud Hadoop INIT状態"
                },
                "cloudHadoopInstanceStatusName": "creating",
                "isHa": true,
                "zone": {
                    "zoneNo": "3",
                    "zoneName": "KR-2",
                    "zoneCode": "KR-2",
                    "zoneDescription": "坪村ゾーン",
                    "regionNo": "1"
                },
                "region": {
                    "regionNo": "1",
                    "regionCode": "KR",
                    "regionName": "Korea"
                },
                "masterNodeServerName": "m-001-cluster999-hd",
                "createDate": "2025-02-28T11:29:26+0900",
                "dataArchitecture": "OBJST",
                "bucketName": "bucket000",
                "directConnectionAccount": "sshuser",
                "loginKeyName": "loginkey000"
            },
            ...
        ],
        "requestId": "d7b932a7-****-****-****-192d44c77deb",
        "returnCode": "0",
        "returnMessage": "success"
    }
}