Available in VPC
Create a Cloud Hadoop cluster.
Request
This section describes the request format. The method and URI are as follows:
| Method | URI |
|---|---|
| GET | POST | /vhadoop/v2/createCloudHadoopInstance |
Note
This guide is based on the GET method. POST method call tests can be performed through Swagger in the API Gateway service of the NAVER Cloud Platform console.
Request headers
For information about the headers common to all Cloud Hadoop APIs, see Cloud Hadoop request headers.
Request query parameters
You can use the following query parameters with your request:
| Field | Type | Required | Description |
|---|---|---|---|
regionCode |
String | Optional | Region code
|
cloudHadoopClusterName |
String | Required | Cluster name
|
cloudHadoopImageProductCode |
String | Optional | Cluster image code
|
cloudHadoopClusterTypeCode |
String | Required | Cluster type code |
cloudHadoopAddOnCodeList |
Array | Optional | Cluster add-on component list
|
useDataCatalog |
Boolean | Optional | Whether to use the Data Catalog service
|
useKdc |
Boolean | Optional | Whether to use Kerberos authentication configuration
|
kdcRealm |
String | Conditional | KDC realm information
|
kdcPassword |
String | Conditional | KDC admin account password
|
vpcNo |
String | Required | VPC number
|
cloudHadoopAdminUserName |
String | Required | Cluster admin account username
|
cloudHadoopAdminUserPassword |
String | Required | Cluster admin account password
|
bucketName |
String | Required | Object Storage bucket name |
useBootstrapScript |
Boolean | Optional | Whether to use bootstrap script
|
bootstrapScript |
String | Conditional | Bootstrap script
|
edgeNodeSubnetNo |
String | Required | Edge node subnet number
|
edgeNodeProductCode |
String | Optional | Edge node server type code
|
masterNodeSubnetNo |
String | Required | Master node subnet number
|
masterNodeProductCode |
String | Optional | Master node server type code
|
masterNodeDataStorageTypeCode |
String | Required | Master node storage type
|
masterNodeDataStorageSize |
Integer | Required | Master node storage capacity (GB)
|
workerNodeSubnetNo |
String | Required | Worker node subnet number
|
workerNodeProductCode |
String | Optional | Worker node server type code
|
workerNodeCount |
Integer | Optional | Number of worker nodes
|
workerNodeDataStorageTypeCode |
String | Required | Worker node storage type
|
workerNodeDataStorageSize |
Integer | Required | Worker node storage capacity (GB)
|
loginKeyName |
String | Required | Authentication key name
|
engineVersionCode |
String | Optional | Engine version code
|
responseFormatType |
String | Optional | Format of the response data
|
Note
The number of master nodes and edge nodes in a cluster can't be set separately.
- Since the Cloud Hadoop service supports high availability (HA) by default, the cluster always includes two master nodes.
- The number of edge nodes is fixed at 1.
Request example
The request example is as follows:
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}'
Response
This section describes the response format.
Response body
The response body includes the following data:
| Field | Type | Required | Description |
|---|---|---|---|
createCloudHadoopInstanceResponse |
Object | - | Response result |
createCloudHadoopInstanceResponse.requestId |
String | - | ID for the request
|
createCloudHadoopInstanceResponse.returnCode |
String | - | Response code |
createCloudHadoopInstanceResponse.returnMessage |
String | - | Response message |
Response status codes
For information about the HTTP status codes common to all Cloud Hadoop APIs, see Cloud Hadoop response status codes.
Response example
The response example is as follows:
{
"createCloudHadoopInstanceResponse": {
"totalRows": 1,
"cloudHadoopInstanceList": [
{
"cloudHadoopInstanceNo": "1000*****",
"cloudHadoopClusterName": "cluster03",
"cloudHadoopInstanceStatusName": "creating",
"cloudHadoopInstanceStatus": {
"code": "INIT",
"codeName": "CLOUD DATABASE (VPC) Init status"
},
"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) server Pending status"
},
"cloudHadoopServerInstanceOperation": {
"code": "CREAT",
"codeName": "CLOUD DATABASE (VPC) server 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) server Pending status"
},
"cloudHadoopServerInstanceOperation": {
"code": "CREAT",
"codeName": "CLOUD DATABASE (VPC) server 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) server Pending status"
},
"cloudHadoopServerInstanceOperation": {
"code": "CREAT",
"codeName": "CLOUD DATABASE (VPC) server 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) server Pending status"
},
"cloudHadoopServerInstanceOperation": {
"code": "CREAT",
"codeName": "CLOUD DATABASE (VPC) server 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) server Pending status"
},
"cloudHadoopServerInstanceOperation": {
"code": "CREAT",
"codeName": "CLOUD DATABASE (VPC) server 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"
}
}