클러스터 생성

Prev Next

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

Search Engine 클러스터를 생성합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
POST /api/v2/cluster/createSearchEngineCluster (수도권)
POST /api/krs-v2/cluster/createSearchEngineCluster (남부권)

요청 헤더

Search Engine Service API에서 공통으로 사용하는 헤더에 대한 정보는 Search Engine Service 요청 헤더를 참조해 주십시오.

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
clusterName String Required 클러스터 이름
  • 영문 소문자, 숫자, 특수 문자 '-'를 조합하여 3~15자로 입력
  • 문자열의 시작은 영문 소문자, 마지막은 영문 소문자 또는 숫자로 구성
  • 특수 문자 '-' 연속 사용 불가
searchEngineVersionCode String Required Search Engine 버전
searchEngineDashboardPort String Required 대시보드 포트 번호
  • 1025~65534
  • 사용 불가 번호: 9090, 9200, 9300
searchEngineUserName String Required Search Engine 관리자 계정 아이디
  • 영문 소문자, 숫자, 특수 문자 '-'를 조합하여 3~15자로 입력
  • 문자열의 시작은 영문 소문자, 마지막은 영문 소문자 또는 숫자로 구성
  • 특수 문자 '-' 연속 사용 불가
searchEngineUserPassword String Required Search Engine 관리자 계정 비밀번호
  • 영문자, 숫자, 특수 문자를 조합하여 8~20자로 입력
  • 사용 불가 특수 문자: ', ", `, ₩, /, &, 공백
softwareProductCode String Required 운영 체제 타입 코드
vpcNo Integer Required VPC 번호
managerNodeSubnetNo Integer Required 매니저 노드 Subnet 번호
isDualManager Boolean Optional 매니저 노드 이중화 여부
  • true (기본값) | false
    • true: 이중화
    • false: 이중화 안 함
managerNodeProductCode String Required 매니저 노드 서버 타입 코드
isMasterOnlyNodeActivated Boolean Optional 마스터 노드 활성화 여부
  • true | false
    • true: 활성화
    • false: 비활성화
masterNodeSubnetNo Integer Conditional 마스터 노드 Subnet 번호
masterNodeCount Integer Conditional 마스터 노드 수
  • 3 (기본값) | 5
  • isMasterOnlyNodeActivated가 true인 경우, 필수 입력
masterNodeProductCode String Conditional 마스터 노드 서버 타입 코드
dataNodeSubnetNo Integer Required 데이터 노드 Subnet 번호
dataNodeCount Integer Required 데이터 노드 수
  • 3~10 (기본값: 3)
dataNodeProductCode String Required 데이터 노드 서버 타입 코드
dataNodeStorageSize Integer Required 데이터 노드 스토리지 용량(GB)
  • 100~2000 (10 GB 단위)
  • 스토리지 타입은 SSD만 지원
loginKeyName String Required 인증키 이름

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request POST 'https://vpcsearchengine.apigw.gov-ntruss.com/api/v2/cluster/createSearchEngineCluster' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
    "clusterName": "cluster006",
    "searchEngineVersionCode": "290",
    "searchEngineDashboardPort": "1025",
    "searchEngineUserName": "ncpadmin",
    "searchEngineUserPassword": "*********",
    "softwareProductCode": "SW.VELST.OS.LNX64.ROCKY.0808.B050",
    "vpcNo": 9****,
    "managerNodeSubnetNo": 20****,
    "managerNodeProductCode": "SVR.VELST.STAND.C002.M008.NET.SSD.B050.G002",
    "isMasterOnlyNodeActivated": true,
    "masterNodeSubnetNo": 20****,
    "masterNodeCount": 3,
    "masterNodeProductCode": "SVR.VELST.STAND.C002.M008.NET.SSD.B050.G002",
    "dataNodeSubnetNo": 20****,
    "dataNodeCount": 3,
    "dataNodeProductCode": "SVR.VELST.STAND.C002.M008.NET.SSD.B050.G002",
    "dataNodeStorageSize": 100,
    "loginKeyName": "loginkey01"
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
code Integer - 응답 코드
message String - 응답 메시지
result Object - 응답 결과
result.serviceGroupInstanceNo Integer - 클러스터 인스턴스 번호
requestId String - 요청에 대한 아이디
  • UUID 형식

응답 상태 코드

Search Engine Service API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Search Engine Service 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "serviceGroupInstanceNo": 1037*****
    },
    "requestId": "1455f9ef-****-****-****-a7e80275e16b"
}