Search Engine Cluster 생성 (VPC)

인쇄
공유
PDF

기사 요약

이 요약이 도움이 되었나요?

의견을 보내 주셔서 감사합니다.

VPC 환경에서 이용 가능합니다.

설명

Search Engine Cluster를 생성합니다.

요청

요청 URL

POST https://vpcsearchengine.apigw.gov-ntruss.com/api/v2/cluster/createSearchEngineCluster [수도권]
POST https://vpcsearchengine.apigw.gov-ntruss.com/api/krs-v2/cluster/createSearchEngineCluster [남부권]

요청 헤더

헤더명	설명
x-ncp-apigw-timestamp	1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타낸 것 API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주 `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-iam-access-key	네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값 `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v2	Access Key ID 값과 Secret Key로 암호화한 서명 `x-ncp-apigw-signature-v2:{API Gateway Signature}`
Content-Type	Request body content type을 application/json으로 지정 `Content-Type: application/json`

요청 파라미터

파라미터	타입	필수 여부	설명
clusterName	String	Y	- 클러스터 이름 영문자(소문자), 숫자, 연속되지 않은 붙임표( - )로만 구성 가능 첫 글자는 영문, 마지막 글자는 영문자 또는 숫자만 가능
searchEngineVersionCode	String	Y	- 사용할 Search Engine 버전 getSearchEngineVersionList 액션을 통해 획득 가능
searchEngineDashboardPort	String	Y	- Search Engine Dashboard(Kibana 또는 Opensearch Dashboard)의 http port 9090, 9200, 9300port는 사용 불가능 1025-65534 사이의 port만 사용 가능
searchEngineUserName	String	Y	- Search Engine Dashboard 접속 ID 영문자(소문자), 숫자, 연속되지 않은 붙임표( - )로만 구성 가능 첫 글자는 영문, 마지막 글자는 영문자 또는 숫자만 가능
searchEngineUserPassword	String	Y	- Search Engine 접속 Password 8자 이상, 영어대소문자/특수문자/숫자 각각 1자 이상 포함 필수
softwareProductCode	String	Y	- 사용할 할 OS 타입 getOsProductList 액션을 통해 획득 가능
vpcNo	Integer	Y	- 사용할 VPC No getVpcList 액션을 통해 획득 가능
isDualManager	Boolean	Y	매니저 노드 이중화 여부
managerNodeSubnetNo	Integer	Y	- 매니저 노드가 위치할 Subnet No getSubnetList
managerNodeProductCode	String	Y	- 매니저 노드의 HW 스펙 getNodeProductList
isMasterOnlyNodeActivated	Boolean	Y	마스터 전용 노드 활성화 여부
masterNodeSubnetNo	Integer	N	- 마스터 노드가 위치할 Subnet No getSubnetList
masterNodeProductCode	String	N	- 마스터 노드의 HW 스펙 getNodeProductList
masterNodeCount	Integer	N	- 마스터 노드의 개수 3대 또는 5대
dataNodeSubnetNo	Integer	Y	- 데이터 노드가 위치할 Subnet No getSubnetList
dataNodeProductCode	String	Y	- 데이터 노드의 HW 스펙 getNodeProductList
dataNodeCount	Integer	Y	- 데이터 노드 개수 최소 3대 이상, 최대 10대까지 생성 가능
dataNodeStorageSize	Integer	Y	- 데이터 노드의 스토리지 용량 최소 100GB, 최대 2000GB 까지 10GB단위 선택 가능
loginKeyName	String	Y	- 매니저 노드 SSH 접속 시 사용할 인증키 이름 getLoginKeyList

요청 예시

POST https://vpcsearchengine.apigw.gov-ntruss.com/api/v2/cluster/createSearchEngineCluster
HOST: vpcsearchengine.apigw.gov-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": "133",
  "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.gov-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": "133",
  "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
}'

응답 파라미터

public class CreateClusterResponseVo {
        private Integer serviceGroupInstanceNo;
}

필드

파라미터명	타입	설명
serviceGroupInstanceNo	Integer	생성된 Cluster의 serviceGroupInstanceNo

응답 예시

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

이 문서가 도움이 되었습니까?

What's Next

Search Engine Version 조회(VPC)

설명
요청
응답 파라미터
필드

태그