Create Search Engine Cluster

Article Summary

Share feedback

Thanks for sharing your feedback!

Can be used in a VPC environment.

Description

Create an Search Engine Cluster.

Request

Request URL

POST https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/createSearchEngineCluster [KR]
POST https://vpcsearchengine.apigw.ntruss.com/api/sgn-v2/cluster/createSearchEngineCluster [SGN]
POST https://vpcsearchengine.apigw.ntruss.com/api/jpn-v2/cluster/createSearchEngineCluster [JPN]

Request headers

Header	Description
x-ncp-apigw-timestamp	This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid. `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	This is the Access Key ID value issued by the Naver Cloud Platform portal. `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v2	This is the signature encrypted Access Key ID value and Secret Key. `x-ncp-apigw-signature-v2:{API Gateway Signature}`
Content-Type	Specifies the request body content type as application/json `Content-Type: application/json`

Request parameters

Parameter	Type	Required status	Description
clusterName	String	Y	This is a cluster name. The name can only contain English letters (lowercase), numbers, and noncontinuous hyphens, and must start with an English letter and end with an English letter or a number.
searchEngineVersionCode	String	Y	This is the Search Engine version to use. You can obtain it through the getSearchEngineVersionList action.
searchEngineDashboardPort	String	Y	This is Search Engine Dashboard port. Ports 9090, 9200, and 9300 are not available, and only ports in the 1025-65534 range are available.
searchEngineUserName	String	Y	This is Search Engine User Name The name can only contain English letters (lowercase), numbers, and noncontinuous hyphens, and must start with an English letter and end with an English letter or a number.
searchEngineUserPassword	String	Y	This is Kibana connection password. The password must be at least 8 characters in length and contain at least one lowercase/uppercase letter, one special character, and one number.
softwareProductCode	String	Y	This is the OS type to use. You can obtain it through the getOsProductList action.
vpcNo	Integer	Y	This is the VPC no. to use. You can obtain it with the getVpcList action.
isDualManager	Boolean	Y	Manager node duplexing status
managerNodeSubnetNo	Integer	Y	This is the subnet no. where the manager node will be located. getSubnetList
managerNodeProductCode	String	Y	This is the HW specification of the manager node. getNodeProductList
isMasterOnlyNodeActivated	Boolean	Y	Dedicated master node activation status
masterNodeSubnetNo	Integer	N	Number of the subnet where the master node will be located getSubnetList
masterNodeProductCode	String	N	Master node HW specifications getNodeProductList
masterNodeCount	Integer	N	Number of master nodes 3 or 5
dataNodeSubnetNo	Integer	Y	This is the subnet no. where the data node will be located. getSubnetList
dataNodeProductCode	String	Y	This is the HW specification of the data node. getNodeProductList
dataNodeCount	Integer	Y	This is the number of data nodes. Possible values range from 3 to 10 nodes.
dataNodeStorageSize	Integer	Y	This is the storage capacity of the data node. You can select a capacity from 100 GB to 2000 GB in increments of 10 GB.
loginKeyName	String	Y	This is the authentication key name to be used when connecting to the manager node using SSH. getLoginKeyList

Request example

POST https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/createSearchEngineCluster
HOST: vpcsearchengine.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-signature-v2: zq0FrtlU8JZJi9esTK31bCQUNG3H+jo4CMjMkJDoWSc=
x-ncp-apigw-timestamp: 1593848345548
x-ncp-iam-access-key: 7fIvgFY428mtY6sY8maw

{
  "clusterName": "testcluster",
  "searchEngineVersionCode": "770",
  "searchEngineDashboardPort" : "5601",
  "searchEngineUserName": "test,
  "searchEngineUserPassword": "qwe123!@#",
  "softwareProductCode": "SW.VELST.OS.LNX64.CNTOS.0703.B050",
  "vpcNo": 1236,
  "managerNodeProductCode": "SVR.VELST.STAND.C002.M004.NET.SSD.B050.G001",
  "managerNodeSubnetNo": 1300,
  "dataNodeProductCode": "SVR.VELST.STAND.C002.M004.NET.SSD.B050.G001",
  "dataNodeCount": 3,
  "dataNodeSubnetNo": 1301,
  "dataNodeStorageSize": 100,
  "loginKeyName": "testkey",
  "isDualManager": true,
  "isMasterOnlyNodeActivated" : false
}

curl -X POST "https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/createSearchEngineCluster" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "x-ncp-iam-access-key: 7fIvgFY428mtY6sY8maw" \
-H "x-ncp-apigw-timestamp: 1601971222179" \
-H "x-ncp-apigw-signature-v2: zrCelnR48AADdK/uh6Xe3yy468i8KpQoewYHUmeqYh4=" \
-d \
'{
  "clusterName": "testcluster",
  "searchEngineVersionCode": "770",
  "searchEngineDashboardPort" : "5601",
  "searchEngineUserName": "test,
  "searchEngineUserPassword": "qwe123!@#",
  "softwareProductCode": "SW.VELST.OS.LNX64.CNTOS.0703.B050",
  "vpcNo": 1236,
  "managerNodeProductCode": "SVR.VELST.STAND.C002.M004.NET.SSD.B050.G001",
  "managerNodeSubnetNo": 1300,
  "dataNodeProductCode": "SVR.VELST.STAND.C002.M004.NET.SSD.B050.G001",
  "dataNodeCount": 3,
  "dataNodeSubnetNo": 1301,
  "dataNodeStorageSize": 100,
  "loginKeyName": "testkey",
  "isDualManager": true,
  "isMasterOnlyNodeActivated" : false
}'

Response parameters

public class CreateClusterResponseVo {
        private Integer serviceGroupInstanceNo;
}

Field

Parameter Name	Type	Description
serviceGroupInstanceNo	Integer	serviceGroupInstanceNo of the cluster created

Response example

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "serviceGroupInstanceNo": 1484582
    },
    "requestId": "2ade3f23-4ef1-48da-9385-f6740a4ad078"
}

Was this article helpful?

What's Next

Get Search Engine version

Table of contents

Description
Request
Response parameters
Field