Search Engine Service 개요
- 인쇄
- PDF
Search Engine Service 개요
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
VPC 환경에서 이용 가능합니다.
Search Engine Service는 다양한 형태의 데이터를 검색, 분석, 시각화할 수 있는 관리형 OpenSearch 및 Elasticsearch 클러스터를 생성하고 관리하도록 돕는 네이버 클라우드 플랫폼의 서비스입니다. Search Engine Service 서비스에서는 Cluster, Dashboard, Monitoring, Snapshot, Import 기능에 대한 API를 RESTful 형태로 제공합니다.
Search Engine Service 공통 설정
Search Engine Service API에서 공통으로 사용하는 요청 형식과 응답 형식을 설명합니다.
요청
공통 요청 형식을 설명합니다.
API URL
요청 API URL은 다음과 같습니다.
https://vpcsearchengine.apigw.ntruss.com
요청 헤더
요청 헤더에 대한 설명은 다음과 같습니다.
| 필드 | 필수 여부 | 설명 |
|---|---|---|
x-ncp-apigw-timestamp | Required | 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간(밀리초)
|
x-ncp-iam-access-key | Required | 네이버 클라우드 플랫폼에서 발급받은 Access Key |
x-ncp-apigw-signature-v2 | Required | 네이버 클라우드 플랫폼에서 발급받은 Access Key에 맵핑되는 Secret Key 및 HMAC 암호화 알고리즘(HmacSHA256)으로 요청 정보를 암호화한 후 Base64로 인코딩한 서명 |
Content-type | Optional | 요청 데이터의 형식
|
응답
공통 응답 형식을 설명합니다.
응답 상태 코드
Search Engine Service API는 네이버 클라우드 플랫폼의 공통 응답 상태 코드를 사용합니다. 네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud API 응답 상태 코드를 참조해 주십시오.
Search Engine Service API
Search Engine Service 서비스에서 제공하는 API에 대한 설명은 다음과 같습니다.
Cluster
Cluster 관련 API에 대한 설명은 다음과 같습니다.
| API | 설명 |
|---|---|
| 계정 비밀번호 초기화 | Search Engine 관리자 계정 비밀번호 초기화 |
| 버전 조회 | 사용 가능한 Search Engine 버전 조회 |
| 버전 업그레이드 | Search Engine 버전 업그레이드 |
| 버전 업그레이드 사전 체크 | Search Engine 버전 업그레이드 사전 체크 |
| 버전 업그레이드 상태 조회 | Search Engine 버전 업그레이드의 진행 상태 조회 |
| 서버 세대 조회 | 사용 가능한 노드 서버 세대 조회 |
| 서버 타입 조회 | 사용 가능한 노드 서버 타입 조회 |
| 서버 타입 조회(G3) | 사용 가능한 노드 서버 타입 조회(3세대 서버 전용) |
| 운영 체제 타입 조회 | 사용 가능한 운영 체제 타입 조회 |
| 운영 체제 타입 조회(G3) | 사용 가능한 운영 체제 타입 조회(3세대 서버 전용) |
| 인증키 목록 조회 | Search Engine 클러스터의 매니저 노드에 SSH 접속 시 사용되는 인증키 목록 조회 |
| Subnet 목록 조회 | 사용 가능한 Subnet 목록 조회 |
| Subnet 목록 조회(G3) | 사용 가능한 Subnet 목록 조회(3세대 서버 전용) |
| VPC 목록 조회 | 사용 가능한 VPC 목록 조회 |
| 클러스터 생성 | Search Engine 클러스터 생성 |
| 클러스터 생성(G3) | Search Engine 클러스터 생성(3세대 서버 전용) |
| 클러스터 목록 조회 | Search Engine 클러스터 목록 조회 |
| 클러스터 조회 | Search Engine 클러스터 상세 정보 조회 |
| ACG 목록 조회 | Search Engine 클러스터 ACG 규칙 목록 조회 |
| 클러스터 재시작 | Search Engine 클러스터 다시 시작 |
| 클러스터 삭제 | Search Engine 클러스터 삭제 |
| 노드 추가 | Search Engine 클러스터 데이터 노드 추가 |
| 노드 목록 조회 | Search Engine 클러스터 노드 목록 조회 |
| 노드별 변경 가능 스펙 조회 | Search Engine 클러스터 노드별 변경 가능 서버 스펙 조회 |
| 노드별 변경 가능 스펙 조회(G3) | Search Engine 클러스터 노드별 변경 가능 서버 스펙 조회(3세대 서버 전용) |
| 노드 스펙 조회 | Search Engine 클러스터 노드별 서버 스펙 조회 |
| 디스크 용량 변경 | Search Engine 클러스터 데이터 노드 서버 디스크 용량 변경 |
| 노드 스펙 변경 | Search Engine 클러스터 노드 서버 스펙 변경 |
| 노드 타입 변경 | Search Engine 클러스터 데이터 노드 타입 변경 |
Dashboard
Dashboard 관련 API에 대한 설명은 다음과 같습니다.
| API | 설명 |
|---|---|
| 대시보드 조회 | Search Engine 클러스터 대시보드 조회 |
Monitoring
Monitoring 관련 API에 대한 설명은 다음과 같습니다.
| API | 설명 |
|---|---|
| 모니터링 결과 조회 | Search Engine 클러스터 및 노드 서버의 모니터링 데이터 조회 |
| 운영 체제 모니터링 결과 조회 | Search Engine 노드 서버의 운영 체제 모니터링 데이터 조회 |
Snapshot
Snapshot 관련 API에 대한 설명은 다음과 같습니다.
| API | 설명 |
|---|---|
| 버킷 목록 조회 | Search Engine 클러스터 스냅샷을 저장할 수 있는 Object Storage 버킷 목록 조회 |
| API 인증키 설정 | Object Storage 접근을 위한 API 인증키 설정 |
| 스냅샷 생성 | Search Engine 클러스터 스냅샷 생성 |
| 스냅샷 생성 이력 조회 | Search Engine 클러스터 스냅샷 생성 이력 조회 |
| 스냅샷 스케줄링 설정 이력 조회 | Search Engine 클러스터 스냅샷 생성 스케줄링 설정 이력 조회 |
| 스냅샷 스케줄링 설정 | Search Engine 클러스터 스냅샷 생성 스케줄링 설정 |
| 스냅샷 스케줄링 설정 해제 | Search Engine 클러스터 스냅샷 생성 스케줄링 설정 해제 |
Import
Import 관련 API에 대한 설명은 다음과 같습니다.
| API | 설명 |
|---|---|
| 버킷 목록 조회 | 데이터 반입 가능한 Object Storage 버킷 목록 조회 |
| 데이터 반입 실행 | Object Storage 버킷에 저장된 데이터의 클러스터 반입 실행 |
| 데이터 반입 이력 조회 | Object Storage 버킷에 저장된 데이터의 클러스터 반입 이력 조회 |
| 데이터 반입 중지 | 실행 중인 데이터 반입 중지 |
Search Engine Service 연관 리소스
Search Engine Service API에 대한 사용자의 이해를 돕기 위해 다양한 연관 리소스를 제공하고 있습니다.
- Search Engine Service API 사용 방법
- 서명(시그니처) 생성: 요청 헤더에 추가할 서명 생성 방법
- API Gateway 사용 가이드: 요청 헤더에 추가할 API Key 발급
- Sub Account 사용 가이드: 요청 헤더에 추가할 Access Key 발급 방법
- Ncloud 공통 응답 상태 코드: Search Engine Service 서비스에서 사용하는 네이버 클라우드 플랫폼의 공통 응답 상태 코드 정보
- Search Engine Service 서비스 사용 방법
- Search Engine Service 사용 가이드: 네이버 클라우드 플랫폼 콘솔에서 Search Engine Service 사용하는 방법
- Ncloud 사용 환경 가이드: VPC, Classic 환경 및 지원 여부에 대한 가이드
- 요금 소개, 특징, 상세 기능: Search Engine Service의 요금 체계, 특징, 상세 기능 요약
- 서비스 최신 소식: Search Engine Service 서비스 관련 최신 소식
- 자주 하는 질문: Search Engine Service 서비스 사용자들이 자주 하는 질문
- 문의하기: API 가이드를 통해서도 궁금증이 해결되지 않는 경우 직접 문의
이 문서가 도움이 되었습니까?