VPC 환경에서 이용 가능합니다.
Search Engine 클러스터의 상세 정보를 조회합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
|---|---|
| GET | /api/v2/cluster/getClusterInfo/{serviceGroupInstanceNo} (한국 리전) |
| GET | /api/sgn-v2/cluster/getClusterInfo/{serviceGroupInstanceNo} (싱가포르 리전) |
| GET | /api/jpn-v2/cluster/getClusterInfo/{serviceGroupInstanceNo} (일본 리전) |
요청 헤더
Search Engine Service API에서 공통으로 사용하는 헤더에 대한 정보는 Search Engine Service 요청 헤더를 참조해 주십시오.
요청 경로 파라미터
요청 경로 파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
serviceGroupInstanceNo |
Integer | Required | 클러스터 인스턴스 번호
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request GET 'https://vpcsearchengine.apigw.ntruss.com/api/v2/cluster/getClusterInfo/1008*****' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
code |
Integer | - | 응답 코드 |
message |
String | - | 응답 메시지 |
result |
Object | - | 응답 결과 |
result.clusterName |
String | - | 클러스터 이름 |
result.clusterStatus |
String | - | 클러스터 상태 |
result.createDate |
String | - | 클러스터 생성 일시 |
result.serviceGroupInstanceNo |
String | - | 클러스터 인스턴스 번호 |
result.vpcNo |
Integer | - | VPC 번호 |
result.softwareProductCode |
String | - | 운영 체제 타입 코드 |
result.searchEngineVersionCode |
String | - | Search Engine 버전 코드 |
result.searchEngineUserName |
String | - | Search Engine 접근 아이디 |
result.searchEnginePort |
String | - | Search Engine 포트 번호 |
result.searchEngineDashboardPort |
String | - | 대시보드 포트 번호 |
result.isDualManager |
Boolean | - | 매니저 노드 이중화 여부
|
result.managerNodeCount |
Integer | - | 매니저 노드 수 |
result.managerNodeSubnetNo |
Integer | - | 매니저 노드 Subnet 번호 |
result.managerNodeProductCode |
String | - | 매니저 노드 서버 타입 코드 |
result.managerNodeAcgId |
Integer | - | 매니저 노드 ACG 아이디 |
result.managerNodeAcgName |
String | - | 매니저 노드 ACG 이름 |
result.dataNodeCount |
Integer | - | 데이터 노드 수 |
result.dataNodeSubnetNo |
Integer | - | 데이터 노드 Subnet 번호 |
result.dataNodeProductCode |
String | - | 데이터 노드 서버 타입 코드 |
result.dataNodeAcgId |
Integer | - | 데이터 노드 ACG 아이디 |
result.dataNodeAcgName |
String | - | 데이터 노드 ACG 이름 |
result.dataNodeStorageSize |
String | - | 데이터 노드별 스토리지 용량(GB) |
result.isMasterOnlyNodeActivated |
Boolean | - | 마스터 노드 활성화 여부
|
result.masterNodeCount |
Integer | - | 마스터 노드 수 |
result.masterNodeSubnetNo |
Integer | - | 마스터 노드 Subnet 번호 |
result.masterNodeProductCode |
String | - | 마스터 노드 서버 타입 코드 |
result.masterNodeAcgId |
Integer | - | 마스터 노드 ACG 아이디 |
result.masterNodeAcgName |
String | - | 마스터 노드 ACG 이름 |
result.loginKeyName |
String | - | 인증키 이름 |
result.managerNodeInstanceNoList |
Array | - | 매니저 노드 인스턴스 번호 목록 |
result.clusterNodeList |
Array | - | 노드 목록 |
requestId |
String | - | 요청에 대한 아이디
|
result.clusterNodeList
result.clusterNodeList에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
computeInstanceName |
String | - | 노드 서버 이름 |
computeInstanceNo |
Integer | - | 노드 서버 인스턴스 번호 |
privateIp |
String | - | 노드 서버 내부 IP |
serverStatus |
String | - | 노드 서버 상태 |
nodeType |
String | - | 노드 타입 |
subnet |
String | - | Subnet 이름 |
응답 상태 코드
Search Engine Service API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Search Engine Service 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"code": 0,
"message": "SUCCESS",
"result": {
"clusterName": "cluster-kvm000",
"clusterStatus": "running",
"createDate": "2025-03-28T10:12:04.488+09:00",
"serviceGroupInstanceNo": "1008*****",
"vpcNo": 4***,
"softwareProductCode": "SW.VELST.OS.LNX64.ROCKY.08.G003",
"searchEngineVersionCode": "2140",
"searchEngineUserName": "userid",
"searchEnginePort": "9200",
"searchEngineDashboardPort": "5601",
"isDualManager": true,
"managerNodeCount": 2,
"managerNodeSubnetNo": 3****,
"managerNodeProductCode": "SVR.VELST.STAND.C002.M008.NET.SSD.B050.G003",
"managerNodeAcgId": 58***,
"managerNodeAcgName": "searchengine-m-1o0xct",
"dataNodeCount": 3,
"dataNodeSubnetNo": 3****,
"dataNodeProductCode": "SVR.VELST.STAND.C002.M008.NET.SSD.B050.G003",
"dataNodeAcgId": 58***,
"dataNodeAcgName": "searchengine-do-1o0xct",
"dataNodeStorageSize": "200",
"isMasterOnlyNodeActivated": true,
"masterNodeCount": 3,
"masterNodeSubnetNo": 3****,
"masterNodeProductCode": "SVR.VELST.STAND.C002.M008.NET.SSD.B050.G003",
"masterNodeAcgId": 58***,
"masterNodeAcgName": "searchengine-mo-1o0xct",
"loginKeyName": "loginkey01",
"managerNodeInstanceNoList": [
1008*****,
1008*****
],
"clusterNodeList": [
{
"computeInstanceName": "cluster-kvm000-m-24c0",
"computeInstanceNo": 1008*****,
"privateIp": "10.0.20.14",
"serverStatus": "running",
"nodeType": "Manager",
"subnet": "sb2 | KR-2 | Private"
},
{
"computeInstanceName": "cluster-kvm000-m-24c1",
"computeInstanceNo": 1008*****,
"privateIp": "10.0.20.15",
"serverStatus": "running",
"nodeType": "Manager",
"subnet": "sb2 | KR-2 | Private"
},
{
"computeInstanceName": "cluster-kvm000-mo-24c2",
"computeInstanceNo": 1008*****,
"privateIp": "10.0.20.16",
"serverStatus": "running",
"nodeType": "Master",
"subnet": "sb2 | KR-2 | Private"
},
{
"computeInstanceName": "cluster-kvm000-mo-24c3",
"computeInstanceNo": 1008*****,
"privateIp": "10.0.20.17",
"serverStatus": "running",
"nodeType": "Master",
"subnet": "sb2 | KR-2 | Private"
},
{
"computeInstanceName": "cluster-kvm000-mo-24c4",
"computeInstanceNo": 1008*****,
"privateIp": "10.0.20.18",
"serverStatus": "running",
"nodeType": "Master",
"subnet": "sb2 | KR-2 | Private"
},
{
"computeInstanceName": "cluster-kvm000-do-24c5",
"computeInstanceNo": 1008*****,
"privateIp": "10.0.20.19",
"serverStatus": "running",
"nodeType": "Data",
"subnet": "sb2 | KR-2 | Private"
},
{
"computeInstanceName": "cluster-kvm000-do-24c6",
"computeInstanceNo": 1008*****,
"privateIp": "10.0.20.20",
"serverStatus": "running",
"nodeType": "Data",
"subnet": "sb2 | KR-2 | Private"
},
{
"computeInstanceName": "cluster-kvm000-do-24c7",
"computeInstanceNo": 1008*****,
"privateIp": "10.0.20.21",
"serverStatus": "running",
"nodeType": "Data",
"subnet": "sb2 | KR-2 | Private"
}
]
},
"requestId": "f4a41d71-****-****-****-753100085283"
}