REST API (REST APIs)
REST API (REST APIs)
Elasticsearch는 REST API를 제공해요. 이 API들은 실제로 Elasticsearch UI(키바나 등)의 각 컴포넌트가 내부적으로 사용하기도 하고, 개발자가 직접 호출해서 기능을 설정하거나 접근할 수도 있어요. UI를 거치지 않고 curl이나 클라이언트 라이브러리로 직접 값을 읽고 쓸 수 있으니, 자동화나 운영 시나리오에서도 널리 쓰여요.
API 레퍼런스 문서는 Elasticsearch API와 Elasticsearch Serverless API에서 확인할 수 있어요.
이 섹션에서 다루는 내용은 다음과 같아요.
- API conventions (API 규칙)
- Common options (공통 옵션)
- Compatibility (호환성)
- Examples (예시)
API endpoints (API 엔드포인트)
아래는 Elasticsearch가 제공하는 주요 API들을 기능별로 정리한 목록이에요. 각 항목의 API 이름과 설명을 표로 정리했어요.
Behavioral analytics (행동 분석)
Behavioral analytics API는 분석 컬렉션(analytics collection)을 만들고 관리하며, 컬렉션에 대한 정보를 조회할 수 있게 해줘요. Behavioral Analytics는 이벤트 수집 플랫폼이에요. 사용자의 검색·클릭 행동을 수집해서 분석할 수 있고, 이 정보를 바탕으로 검색 결과의 관련성을 높이고 콘텐츠의 부족한 부분을 찾아낼 수 있어요.
| API | 설명 |
|---|---|
| Get Collections (컬렉션 조회) | 모든 behavioral analytics 컬렉션 목록을 보여줘요. |
| Create Collection (컬렉션 생성) | 새로운 behavioral analytics 컬렉션을 만들어요. |
| Delete Collection (컬렉션 삭제) | behavioral analytics 컬렉션을 삭제해요. |
| Create Event (이벤트 생성) | behavioral analytics 이벤트를 컬렉션으로 보내요. |
Compact and aligned text (CAT)
Compact and aligned text(CAT) API는 JSON 객체 대신 사람이 읽기 좋은 텍스트를 응답으로 돌려줘요. CAT API는 Kibana 콘솔이나 커맨드라인에서 사람이 읽는 용도로만 쓰도록 설계됐어요. 애플리케이션에서 쓰기 위한 게 아니에요. 애플리케이션에서 소비하려면 해당 기능의 JSON API를 쓰는 걸 권장해요.
| API | 설명 |
|---|---|
| Get aliases (별칭 조회) | 인덱스 별칭(alias)을 반환해요. |
| Get allocation (할당 조회) | 노드 간 샤드 할당 현황을 보여줘요. |
| Get component templates (컴포넌트 템플릿 조회) | 컴포넌트 템플릿 정보를 반환해요. |
| Get count (카운트 조회) | 지정한 인덱스의 문서 수를 반환해요. |
| Get fielddata (필드데이터 조회) | 필드별 fielddata 메모리 사용량을 보여줘요. |
| Get health (헬스 조회) | 클러스터 상태를 반환해요. |
| Get help (도움말) | CAT API 사용법을 보여줘요. |
| Get index information (인덱스 정보 조회) | 인덱스 통계를 반환해요. |
| Get master (마스터 조회) | 선출된 마스터 노드 정보를 반환해요. |
| Get ml data frame analytics (ML 데이터프레임 분석 조회) | 데이터 프레임 분석 작업을 반환해요. |
| Get ml datafeeds (ML 데이터피드 조회) | 데이터피드 정보를 반환해요. |
| Get ml jobs (ML 잡 조회) | 이상 탐지(anomaly detection) 작업을 반환해요. |
| Get ml trained models (ML 학습 모델 조회) | 학습된 머신러닝 모델을 반환해요. |
| Get nodeattrs (노드 속성 조회) | 커스텀 노드 속성을 반환해요. |
| Get node information (노드 정보 조회) | 클러스터 노드 정보와 통계를 반환해요. |
| Get pending tasks (대기 작업 조회) | 클러스터의 대기 중인 작업을 반환해요. |
| Get plugins (플러그인 조회) | 설치된 플러그인 정보를 반환해요. |
| Get recovery (리커버리 조회) | 샤드 리커버리 정보를 반환해요. |
| Get repositories (레포지토리 조회) | 스냅샷 레포지토리 정보를 반환해요. |
| Get segments (세그먼트 조회) | 저수준 세그먼트 정보를 반환해요. |
| Get shard information (샤드 정보 조회) | 노드 간 샤드 할당을 반환해요. |
| Get snapshots (스냅샷 조회) | 스냅샷 정보를 반환해요. |
| Get tasks (작업 조회) | 실행 중인 작업 정보를 반환해요. |
| Get templates (템플릿 조회) | 인덱스 템플릿 정보를 반환해요. |
| Get thread pool (스레드 풀 조회) | 스레드 풀 통계를 반환해요. |
| Get transforms (트랜스폼 조회) | 트랜스폼 정보를 반환해요. |
Cluster (클러스터)
클러스터 API는 클러스터, 노드, 샤드 수준에서 인프라 정보를 조회할 수 있게 해줘요. 클러스터 설정과 투표 구성 예외(voting configuration exclusion)를 관리하고, 노드 통계를 수집하거나 노드 정보를 조회할 수도 있어요.
| API | 설명 |
|---|---|
| Get cluster health (클러스터 헬스 조회) | 클러스터의 상태를 반환해요. |
| Get cluster info (클러스터 정보 조회) | 클러스터에 대한 기본 정보를 반환해요. |
| Reroute cluster (클러스터 재라우팅) | 샤드 할당을 수동으로 다시 지정해요. |
| Get cluster state (클러스터 상태 조회) | 현재 클러스터 상태를 가져와요. |
| Explain shard allocation (샤드 할당 설명) | 클러스터 내 샤드 할당에 대한 설명을 가져와요. |
| Update cluster settings (클러스터 설정 업데이트) | 영구(persistent) 또는 일시(transient) 클러스터 설정을 업데이트해요. |
| Get cluster stats (클러스터 통계 조회) | 노드·인덱스·샤드 지표를 포함한 클러스터 전체 통계를 반환해요. |
| Get cluster pending tasks (클러스터 대기 작업 조회) | 실행을 기다리는 클러스터 수준 작업을 나열해요. |
| Get cluster settings (클러스터 설정 조회) | persistent·transient 설정을 포함한 클러스터 전체 설정을 가져와요. |
| Get cluster remote info (원격 클러스터 정보 조회) | 크로스클러스터 검색·복제를 위해 구성된 원격 클러스터 정보를 반환해요. |
| Update cluster voting config exclusions (투표 구성 예외 업데이트) | 노드 ID나 노드 이름으로 클러스터 투표 구성 예외를 업데이트해요. |
| Delete voting config exclusions (투표 구성 예외 삭제) | 투표 구성 예외를 지워서 이전에 제외된 노드가 마스터 선거에 참여할 수 있게 해요. |
| Exclude nodes from voting (노드 투표 제외) | 마스터 선거 투표에서 노드를 제외해요. |
| Clear voting config exclusions (투표 구성 예외 초기화) | 투표 구성 예외를 지워요. |
Cluster - Health (클러스터 헬스)
Cluster - Health API는 Elasticsearch 클러스터의 상태에 대한 보고서를 제공해요.
| API | 설명 |
|---|---|
| Get cluster health report (클러스터 헬스 보고서) | 인덱스 수준 세부 정보를 포함한 클러스터 상태를 반환해요. |
Connector (커넥터)
커넥터와 동기화 작업(sync job) API는 내부 인덱스에서 Elastic 커넥터와 동기화 작업을 만들고 관리하는 편리한 방법을 제공해요.
| API | 설명 |
|---|---|
| Get connector (커넥터 조회) | 커넥터 구성을 가져와요. |
| Put connector (커넥터 생성/업데이트) | 커넥터 구성을 만들거나 업데이트해요. |
| Delete connector (커넥터 삭제) | 커넥터 구성을 삭제해요. |
| Start connector sync job (동기화 작업 시작) | 커넥터의 동기화 작업을 시작해요. |
| Get connector sync job (동기화 작업 조회) | 커넥터의 동기화 작업 세부 정보를 가져와요. |
| Get all connectors (전체 커넥터 조회) | 모든 커넥터 구성 목록을 가져와요. |
| Get all connector sync jobs (전체 동기화 작업 조회) | 모든 커넥터 동기화 작업 목록을 가져와요. |
| Delete connector sync job (동기화 작업 삭제) | 커넥터 동기화 작업을 삭제해요. |
Cross-cluster replication (CCR, 크로스클러스터 복제)
크로스클러스터 복제(CCR) API는 팔로워 인덱스(follower index)나 auto-follow 패턴을 만들고 관리하는 등 크로스클러스터 복제 작업을 실행할 수 있게 해줘요. CCR을 쓰면 데이터센터 장애에도 검색 요청을 계속 처리하도록 인덱스를 여러 클러스터에 복제할 수 있고, 검색 볼륨이 인덱싱 처리량을 방해하지 않게 하며, 사용자와 지리적으로 가까운 곳에서 검색 요청을 처리해 검색 지연을 줄일 수 있어요.
| API | 설명 |
|---|---|
| Create or update auto-follow pattern (auto-follow 패턴 생성/업데이트) | auto-follow 패턴을 만들거나 업데이트해요. |
| Delete auto-follow pattern (auto-follow 패턴 삭제) | auto-follow 패턴을 삭제해요. |
| Get auto-follow pattern (auto-follow 패턴 조회) | auto-follow 패턴 구성을 가져와요. |
| Pause auto-follow pattern (auto-follow 패턴 일시중지) | auto-follow 패턴을 일시중지해요. |
| Resume auto-follow pattern (auto-follow 패턴 재개) | 일시중지된 auto-follow 패턴을 재개해요. |
| Forget follower (팔로워 잊기) | 리더 인덱스에서 팔로워 보존 리스(lease)를 제거해요. |
| Create follower (팔로워 생성) | 팔로워 인덱스를 만들어요. |
| Get follower (팔로워 조회) | 팔로워 인덱스 정보를 가져와요. |
| Get follower stats (팔로워 통계 조회) | 팔로워 인덱스의 통계를 가져와요. |
| Pause follower (팔로워 일시중지) | 팔로워 인덱스의 복제를 일시중지해요. |
| Resume follower (팔로워 재개) | 일시중지된 팔로워 인덱스의 복제를 재개해요. |
| Unfollow index (언팔로우) | 팔로워 인덱스를 일반 인덱스로 전환해요. |
| Get CCR stats (CCR 통계 조회) | 클러스터 전체 CCR 통계를 가져와요. |
Data stream (데이터 스트림)
데이터 스트림 API는 데이터 스트림과 데이터 스트림 라이프사이클을 만들고 관리할 수 있게 해줘요. 데이터 스트림은 여러 인덱스에 걸쳐 append-only(추가 전용) 시계열 데이터를 저장하면서, 요청에는 하나의 이름을 가진 리소스로 제공해줘요. 로그, 이벤트, 지표 등 지속적으로 생성되는 데이터에 잘 맞아요.
| API | 설명 |
|---|---|
| Create data stream (데이터 스트림 생성) | 새로운 데이터 스트림을 만들어요. |
| Delete data stream (데이터 스트림 삭제) | 기존 데이터 스트림을 삭제해요. |
| Get data stream (데이터 스트림 조회) | 하나 이상의 데이터 스트림을 가져와요. |
| Modify data stream (데이터 스트림 수정) | 데이터 스트림의 백킹 인덱스 구성을 업데이트해요. |
| Promote data stream write index (라이트 인덱스 승격) | 백킹 인덱스를 라이트(write) 인덱스로 승격해요. |
| Data streams stats (데이터 스트림 통계) | 데이터 스트림에 대한 통계를 반환해요. |
| Migrate to data stream (데이터 스트림 마이그레이션) | 인덱스를 데이터 스트림으로 마이그레이션해요. |
Document (문서)
문서 API는 Elasticsearch 인덱스에서 문서를 만들고 관리할 수 있게 해줘요.
| API | 설명 |
|---|---|
| Index document (문서 인덱싱) | 문서를 특정 인덱스에 인덱싱해요. |
| Get document (문서 조회) | ID로 문서를 가져와요. |
| Delete document (문서 삭제) | ID로 문서를 삭제해요. |
| Update document (문서 업데이트) | 스크립트나 부분 문서(partial doc)로 문서를 업데이트해요. |
| Bulk (벌크) | 단일 API 호출로 여러 인덱싱 또는 삭제 작업을 수행해요. |
| Multi-get document (멀티 문서 조회) | 한 요청으로 여러 문서를 ID로 가져와요. |
| Update documents by query (쿼리로 문서 업데이트) | 쿼리와 일치하는 문서를 업데이트해요. |
| Delete documents by query (쿼리로 문서 삭제) | 쿼리와 일치하는 문서를 삭제해요. |
| Get term vectors (텀 벡터 조회) | 문서의 텀 벡터를 가져와요. |
| Multi-termvectors (멀티 텀 벡터) | 여러 문서의 텀 벡터를 가져와요. |
| Reindex (재인덱싱) | 한 인덱스에서 다른 인덱스로 문서를 복사해요. |
| Reindex Rethrottle (재인덱싱 스로틀 변경) | 실행 중인 reindex 작업의 스로틀을 변경해요. |
| Explain (설명) | 문서가 쿼리와 어떻게 일치하는지(또는 일치하지 않는지) 설명해요. |
| Get source (소스 조회) | ID로 문서의 소스를 가져와요. |
| Exists (존재 확인) | ID로 문서가 존재하는지 확인해요. |
Enrich (인리치)
Enrich API는 인리치 정책(enrich policy)을 관리할 수 있게 해줘요. 인리치 정책은 들어오는 문서에 적절한 인리치 데이터를 추가하는 데 사용하는 구성 옵션 세트예요.
| API | 설명 |
|---|---|
| Create or update enrich policy (인리치 정책 생성/업데이트) | 인리치 정책을 만들거나 업데이트해요. |
| Get enrich policy (인리치 정책 조회) | 인리치 정책 정의를 가져와요. |
| Delete enrich policy (인리치 정책 삭제) | 인리치 정책을 삭제해요. |
| Execute enrich policy (인리치 정책 실행) | 인리치 정책을 실행해 인리치 인덱스를 만들어요. |
| Get enrich stats (인리치 통계 조회) | 인리치 코디네이터와 정책 실행 통계를 반환해요. |
EQL
EQL API는 EQL 관련 작업을 실행할 수 있게 해줘요. Event Query Language(EQL)는 로그, 지표, 트레이스 같은 이벤트 기반 시계열 데이터를 위한 쿼리 언어예요.
| API | 설명 |
|---|---|
| Submit EQL search (EQL 검색 제출) | EQL 검색을 실행해요. |
| Get EQL search status (EQL 검색 상태 조회) | 비동기 EQL 검색의 상태를 가져와요. |
| Get EQL search results (EQL 검색 결과 조회) | 비동기 EQL 검색의 결과를 가져와요. |
| Delete EQL search (EQL 검색 삭제) | 비동기 EQL 검색을 취소해요. |
ES|QL
ES|QL API는 ES|QL 관련 작업을 실행할 수 있게 해줘요. Elasticsearch Query Language(ES|QL)는 Elasticsearch에 저장된 데이터를 필터링·변환·분석하는 강력한 방법을 제공해요. 앞으로는 다른 런타임에서도 지원할 예정이에요.
| API | 설명 |
|---|---|
| ES|QL Query (ES|QL 쿼리) | SQL과 유사한 문법으로 ES|QL 쿼리를 실행해요. |
| ES|QL Async Submit (비동기 제출) | ES|QL 쿼리를 비동기로 제출해요. |
| ES|QL Async Get (비동기 결과 조회) | 비동기 ES|QL 쿼리의 결과를 가져와요. |
| ES|QL Async Delete (비동기 삭제) | 비동기 ES|QL 쿼리를 취소해요. |
Features (기능)
Feature API는 Elasticsearch와 Elasticsearch 플러그인이 제공하는 기능을 들여다보고 관리할 수 있게 해줘요.
| API | 설명 |
|---|---|
| Get Features (기능 조회) | 클러스터에서 사용 가능한 모든 기능을 나열해요. |
| Reset Features (기능 리셋) | 시스템 기능의 내부 상태를 리셋해요. |
Fleet
Fleet API는 Fleet이 Elasticsearch를 내부 에이전트·액션 데이터 저장소로 사용하는 것을 지원해요.
| API | 설명 |
|---|---|
| Run Multiple Fleet Searches (멀티 Fleet 검색) | 단일 API 요청으로 여러 Fleet 검색을 실행해요. |
| Run a Fleet Search (Fleet 검색) | Fleet 검색을 실행해요. |
| Get global checkpoints (글로벌 체크포인트 조회) | 인덱스의 현재 글로벌 체크포인트를 가져와요. |
Graph explore (그래프 탐색)
Graph explore API는 Elasticsearch 데이터 스트림이나 인덱스의 문서와 텀에 대한 정보를 추출·요약할 수 있게 해줘요.
| API | 설명 |
|---|---|
| Graph Explore (그래프 탐색) | 관련성 기반 그래프 탐색으로 인덱싱된 텀 간의 관계를 발견해요. |
Index (인덱스)
인덱스 API는 개별 인덱스, 인덱스 설정, 별칭, 매핑, 인덱스 템플릿을 관리할 수 있게 해줘요.
| API | 설명 |
|---|---|
| Create index (인덱스 생성) | 선택적 설정·매핑을 포함한 새 인덱스를 만들어요. |
| Delete index (인덱스 삭제) | 기존 인덱스를 삭제해요. |
| Get index (인덱스 조회) | 하나 이상의 인덱스 정보를 가져와요. |
| Open index (인덱스 열기) | 닫힌 인덱스를 열어 작업에 사용할 수 있게 해요. |
| Close index (인덱스 닫기) | 리소스를 확보하려고 인덱스를 닫아요. |
| Shrink index (인덱스 축소) | 프라이머리 샤드가 더 적은 새 인덱스로 기존 인덱스를 축소해요. |
| Split index (인덱스 분할) | 프라이머리 샤드가 더 많은 새 인덱스로 기존 인덱스를 분할해요. |
| Clone index (인덱스 복제) | 기존 인덱스를 새 인덱스로 복제해요. |
| Check alias (별칭 체크) | 인덱스 별칭을 관리해요. |
| Update field mappings (필드 매핑 업데이트) | 인덱스 매핑을 업데이트해요. |
| Get field mappings (필드 매핑 조회) | 인덱스 매핑을 가져와요. |
| Get index settings (인덱스 설정 조회) | 하나 이상의 인덱스 설정을 가져와요. |
| Update index settings (인덱스 설정 업데이트) | 인덱스 수준 설정을 동적으로 업데이트해요. |
| Get index templates (인덱스 템플릿 조회) | 레거시 인덱스 템플릿을 가져와요. |
| Put index template (인덱스 템플릿 생성/업데이트) | 레거시 인덱스 템플릿을 만들거나 업데이트해요. |
| Delete index template (인덱스 템플릿 삭제) | 레거시 인덱스 템플릿을 삭제해요. |
| Get composable index templates (컴포저블 템플릿 조회) | 컴포저블(composable) 인덱스 템플릿을 가져와요. |
| Put composable index template (컴포저블 템플릿 생성/업데이트) | 컴포저블 인덱스 템플릿을 만들거나 업데이트해요. |
| Delete composable index template (컴포저블 템플릿 삭제) | 컴포저블 인덱스 템플릿을 삭제해요. |
| Get index alias (인덱스 별칭 조회) | 인덱스 별칭을 가져와요. |
| Delete index alias (인덱스 별칭 삭제) | 인덱스 별칭을 삭제해요. |
| Refresh index (인덱스 리프레시) | 하나 이상의 인덱스를 리프레시해 최근 변경 사항을 검색 가능하게 해요. |
| Flush index (인덱스 플러시) | 하나 이상의 인덱스에 플러시 작업을 수행해요. |
| Clear index cache (인덱스 캐시 초기화) | 하나 이상의 인덱스와 연관된 캐시를 지워요. |
| Force merge index (포스 머지) | 인덱스 세그먼트를 병합해 개수를 줄이고 성능을 높여요. |
| Rollover index (롤오버) | 조건이 충족되면 별칭을 새 인덱스로 롤오버해요. |
| Resolve index (인덱스 해석) | 표현식을 인덱스 이름·별칭·데이터 스트림으로 해석해요. |
| Simulate index template (컴포저블 템플릿 시뮬레이션) | 컴포저블 인덱스 템플릿 적용을 시뮬레이션해요. |
| Simulate template (레거시 템플릿 시뮬레이션) | 레거시 인덱스 템플릿 적용을 시뮬레이션해요. |
| Get mapping (매핑 조회) | 하나 이상의 인덱스 매핑 정의를 가져와요. |
| Put mapping (매핑 업데이트) | 하나 이상의 인덱스 매핑 정의를 업데이트해요. |
| Reload search analyzers (검색 애널라이저 리로드) | 하나 이상의 인덱스 검색 애널라이저를 리로드해요. |
Index lifecycle management (ILM, 인덱스 라이프사이클 관리)
인덱스 라이프사이클 관리 API는 인덱스 라이프사이클을 자동으로 관리하는 정책을 구성할 수 있게 해줘요.
| API | 설명 |
|---|---|
| Put Lifecycle Policy (라이프사이클 정책 생성/업데이트) | ILM 정책을 만들거나 업데이트해요. |
| Get Lifecycle Policy (라이프사이클 정책 조회) | 하나 이상의 ILM 정책을 가져와요. |
| Delete Lifecycle Policy (라이프사이클 정책 삭제) | ILM 정책을 삭제해요. |
| Explain Lifecycle (라이프사이클 설명) | 인덱스의 현재 라이프사이클 단계를 보여줘요. |
| Move to Step (단계 이동) | 인덱스를 라이프사이클의 다음 단계로 수동 이동해요. |
| Retry Lifecycle Step (라이프사이클 단계 재시도) | 실패한 인덱스의 현재 라이프사이클 단계를 재시도해요. |
| Start ILM (ILM 시작) | ILM 플러그인을 시작해요. |
| Stop ILM (ILM 중지) | ILM 플러그인을 중지해요. |
| Get ILM Status (ILM 상태 조회) | ILM 플러그인의 상태를 반환해요. |
Inference (추론)
Inference API는 추론 엔드포인트를 만들고 Amazon Bedrock, Anthropic, Azure AI Studio, Cohere, Google AI, Groq, Mistral, OpenAI, HuggingFace 등 다양한 서비스의 머신러닝 모델과 통합할 수 있게 해줘요.
| API | 설명 |
|---|---|
| Put Inference Endpoint (추론 엔드포인트 생성) | 추론 엔드포인트를 만들어요. |
| Get Inference Endpoint (추론 엔드포인트 조회) | 하나 이상의 추론 엔드포인트를 가져와요. |
| Delete Inference Endpoint (추론 엔드포인트 삭제) | 추론 엔드포인트를 삭제해요. |
| Infer (추론 실행) | 배포된 모델로 추론을 실행해요. |
Info (정보)
Info API는 빌드, 버전, 클러스터에 대한 기본 정보를 제공해요.
| API | 설명 |
|---|---|
| Get cluster information (클러스터 정보 조회) | 클러스터에 대한 기본 정보를 반환해요. |
Ingest (인제스트)
Ingest API는 인제스트 파이프라인과 프로세서 관련 작업·리소스를 관리할 수 있게 해줘요.
| API | 설명 |
|---|---|
| Create or update pipeline (파이프라인 생성/업데이트) | 인제스트 파이프라인을 만들거나 업데이트해요. |
| Get pipeline (파이프라인 조회) | 하나 이상의 인제스트 파이프라인을 가져와요. |
| Delete pipeline (파이프라인 삭제) | 인제스트 파이프라인을 삭제해요. |
| Simulate pipeline (파이프라인 시뮬레이션) | 인제스트 파이프라인을 통해 문서를 시뮬레이션해요. |
| Get built-in grok patterns (기본 grok 패턴 조회) | 내장된 grok 패턴 목록을 반환해요. |
Licensing (라이선스)
라이선싱 API는 라이선스를 관리할 수 있게 해줘요.
| API | 설명 |
|---|---|
| Get license (라이선스 조회) | 클러스터의 현재 라이선스를 가져와요. |
| Update license (라이선스 업데이트) | 클러스터의 라이선스를 업데이트해요. |
| Delete license (라이선스 삭제) | 현재 라이선스를 제거해요. |
| Start basic license (베이직 라이선스 시작) | basic 라이선스를 시작해요. |
| Start trial license (트라이얼 라이선스 시작) | trial 라이선스를 시작해요. |
| Get the trial status (트라이얼 상태 조회) | 현재 trial 라이선스의 상태를 반환해요. |
Logstash
Logstash API는 Logstash Central Management에서 사용하는 파이프라인을 관리할 수 있게 해줘요.
| API | 설명 |
|---|---|
| Create or update Logstash pipeline (Logstash 파이프라인 생성/업데이트) | Logstash 파이프라인을 만들거나 업데이트해요. |
| Get Logstash pipeline (Logstash 파이프라인 조회) | 하나 이상의 Logstash 파이프라인을 가져와요. |
| Delete Logstash pipeline (Logstash 파이프라인 삭제) | Logstash 파이프라인을 삭제해요. |
Machine learning (머신러닝)
머신러닝 API는 Elastic Stack 머신러닝 기능과 관련된 정보를 조회할 수 있게 해줘요.
| API | 설명 |
|---|---|
| Get machine learning memory stats (ML 메모리 통계 조회) | 머신러닝 작업과 학습 모델이 메모리를 어떻게 사용하는지 정보를 가져와요. |
| Get machine learning info (ML 정보 조회) | 머신러닝이 사용하는 기본값과 한도를 가져와요. |
| Set upgrade mode (업그레이드 모드 설정) | 머신러닝 인덱스를 업그레이드에 대비시키는 클러스터 전체 upgrade_mode 설정을 지정해요. |
| Get ML job stats (ML 잡 통계 조회) | ML 작업의 사용 통계를 가져와요. |
| Get ML calendar events (ML 캘린더 이벤트 조회) | ML 캘린더의 예약 이벤트를 가져와요. |
| Get ML filters (ML 필터 조회) | ML 필터를 가져와요. |
| Put ML filter (ML 필터 생성/업데이트) | ML 필터를 만들거나 업데이트해요. |
| Delete ML filter (ML 필터 삭제) | ML 필터를 삭제해요. |
| Get ML info (ML 정보 조회) | 전체 ML 정보를 가져와요. |
| Get ML model snapshots (ML 모델 스냅샷 조회) | ML 작업의 모델 스냅샷을 가져와요. |
| Revert ML model snapshot (ML 모델 스냅샷 복원) | ML 작업을 이전 모델 스냅샷으로 되돌려요. |
| Delete expired ML data (만료 ML 데이터 삭제) | 만료된 ML 결과와 모델 스냅샷을 삭제해요. |
Machine learning anomaly detection (머신러닝 이상 탐지)
머신러닝 이상 탐지 API는 이상 탐지 활동을 수행할 수 있게 해줘요.
| API | 설명 |
|---|---|
| Put Job (잡 생성) | 이상 탐지 작업을 만들어요. |
| Get Job (잡 조회) | 이상 탐지 작업의 구성 정보를 가져와요. |
| Delete Job (잡 삭제) | 이상 탐지 작업을 삭제해요. |
| Open Job (잡 열기) | 기존 이상 탐지 작업을 열어요. |
| Close anomaly detection jobs (잡 닫기) | 이상 탐지 작업을 닫아요. |
| Flush Job (잡 플러시) | 버퍼링된 데이터가 처리되도록 강제해요. |
| Forecast Job (잡 예측) | 이상 탐지 작업에 대한 예측을 생성해요. |
| Get Buckets (버킷 조회) | 작업의 버킷 결과를 가져와요. |
| Get Records (레코드 조회) | 작업의 이상 레코드를 가져와요. |
| Get calendar configuration info (캘린더 구성 조회) | 캘린더 구성 정보를 가져와요. |
| Create a calendar (캘린더 생성) | 캘린더를 만들어요. |
| Delete a calendar (캘린더 삭제) | 캘린더를 삭제해요. |
| Delete events from a calendar (캘린더 이벤트 삭제) | 캘린더에서 이벤트를 삭제해요. |
| Add anomaly detection job to calendar (잡을 캘린더에 추가) | 캘린더에 이상 탐지 작업을 추가해요. |
| Delete anomaly detection jobs from calendar (캘린더에서 잡 삭제) | 캘린더에서 이상 탐지 작업을 삭제해요. |
| Get datafeeds configuration info (데이터피드 구성 조회) | 데이터피드의 구성 정보를 가져와요. |
| Create datafeed (데이터피드 생성) | 데이터피드를 만들어요. |
| Delete a datafeed (데이터피드 삭제) | 데이터피드를 삭제해요. |
| Delete expired ML data (만료 ML 데이터 삭제) | 보존 기간을 초과한 모든 작업 결과·모델 스냅샷·예측 데이터를 삭제해요. |
| Get filters (필터 조회) | 단일 필터 또는 모든 필터를 가져와요. |
| Get anomaly detection job results for influencers (인플루언서 결과 조회) | 이상에 기여했거나 원인인 엔티티의 이상 탐지 작업 결과를 가져와요. |
| Get anomaly detection job stats (잡 통계 조회) | 이상 탐지 작업 통계를 가져와요. |
| Get anomaly detection jobs configuration info (잡 구성 조회) | 그룹 이름, 쉼표로 구분된 작업 목록, 또는 와일드카드 표현식으로 단일 요청에서 여러 작업 정보를 가져올 수 있어요. |
Machine learning data frame analytics (머신러닝 데이터 프레임 분석)
머신러닝 데이터 프레임 분석 API는 데이터 프레임 분석 활동을 수행할 수 있게 해줘요.
| API | 설명 |
|---|---|
| Create a data frame analytics job (데이터 프레임 분석 작업 생성) | 데이터 프레임 분석 작업을 만들어요. |
| Get data frame analytics job configuration info (작업 구성 조회) | 분석 작업의 구성과 결과를 가져와요. |
| Delete a data frame analytics job (작업 삭제) | 데이터 프레임 분석 작업을 삭제해요. |
| Start a data frame analytics job (작업 시작) | 데이터 프레임 분석 작업을 시작해요. |
| Stop data frame analytics jobs (작업 중지) | 실행 중인 데이터 프레임 분석 작업을 중지해요. |
Machine learning trained models (머신러닝 학습 모델)
머신러닝 학습 모델 API는 모델 관리 작업을 수행할 수 있게 해줘요.
| API | 설명 |
|---|---|
| Put Trained Model (학습 모델 업로드) | 추론을 위해 학습 모델을 업로드해요. |
| Get Trained Models (학습 모델 조회) | 학습 모델의 구성과 통계를 가져와요. |
| Delete Trained Model (학습 모델 삭제) | 학습 모델을 삭제해요. |
| Start Deployment (배포 시작) | 학습 모델 배포를 시작해요. |
| Stop Deployment (배포 중지) | 학습 모델 배포를 중지해요. |
| Get Deployment Stats (배포 통계 조회) | 배포된 모델의 통계를 가져와요. |
Migration (마이그레이션)
마이그레이션 API는 Kibana의 Upgrade Assistant 기능을 지원해요.
| API | 설명 |
|---|---|
| Deprecation Info (디프리케이션 정보) | 클러스터와 인덱스의 디프리케이션(사용 중단) 경고를 가져와요. |
| Get Feature Upgrade Status (기능 업그레이드 상태 조회) | 시스템 기능의 업그레이드 상태를 확인해요. |
| Post Feature Upgrade (기능 업그레이드 실행) | 버전 업그레이드 후 내부 시스템 기능을 업그레이드해요. |
Query rules (쿼리 규칙)
Query rules는 특정 규칙과 일치하는 쿼리에 대해 쿼리 실행 시점에 적용할 수 있게 해줘요. 쿼리 규칙은 규칙셋(ruleset)으로 구성되는데, 규칙셋은 들어오는 쿼리에 매칭되는 쿼리 규칙의 모음이에요. 규칙은 rule query를 사용해 적용해요. 쿼리가 규칙셋의 하나 이상의 규칙과 일치하면, 검색 전에 규칙을 적용하도록 쿼리를 다시 작성해요. 이를 통해 특정 텀과 일치하는 쿼리에만 문서를 고정(pin)할 수 있어요.
| API | 설명 |
|---|---|
| Create or update query ruleset (규칙셋 생성/업데이트) | 쿼리 규칙셋을 만들거나 업데이트해요. |
| Get query ruleset (규칙셋 조회) | 하나 이상의 쿼리 규칙셋을 가져와요. |
| Delete query ruleset (규칙셋 삭제) | 쿼리 규칙셋을 삭제해요. |
Rollup (롤업)
롤업 API는 롤업 작업을 만들고 관리하며 정보를 조회할 수 있게 해줘요.
| API | 설명 |
|---|---|
| Create or update rollup job (롤업 작업 생성/업데이트) | 과거 데이터를 요약하기 위한 롤업 작업을 만들거나 업데이트해요. |
| Get rollup jobs (롤업 작업 조회) | 하나 이상의 롤업 작업 구성을 가져와요. |
| Delete rollup job (롤업 작업 삭제) | 롤업 작업을 삭제해요. |
| Start rollup job (롤업 작업 시작) | 롤업 작업을 시작해요. |
| Stop rollup job (롤업 작업 중지) | 실행 중인 롤업 작업을 중지해요. |
| Get rollup capabilities (롤업 기능 조회) | 롤업 작업의 기능을 반환해요. |
| Search rollup data (롤업 데이터 검색) | 롤업 인덱스를 사용해 롤업된 데이터를 검색해요. |
Script (스크립트)
스크립트 지원 API로 지원되는 스크립트 컨텍스트와 언어 목록을 가져올 수 있어요. 저장된 스크립트(stored script) API로 저장된 스크립트와 검색 템플릿을 관리할 수 있어요.
| API | 설명 |
|---|---|
| Add or update stored script (저장 스크립트 생성/업데이트) | 저장된 스크립트를 추가하거나 업데이트해요. |
| Get stored script (저장 스크립트 조회) | 저장된 스크립트를 가져와요. |
| Delete stored script (저장 스크립트 삭제) | 저장된 스크립트를 삭제해요. |
| Execute Painless script (Painless 스크립트 실행) | Painless 언어로 스크립트를 실행해요. |
| Get script contexts (스크립트 컨텍스트 조회) | 사용 가능한 스크립트 실행 컨텍스트를 반환해요. |
| Get script languages (스크립트 언어 조회) | 사용 가능한 스크립팅 언어를 반환해요. |
Search (검색)
검색 API는 Elasticsearch 인덱스와 데이터 스트림에 저장된 데이터를 검색하고 집계할 수 있게 해줘요.
| API | 설명 |
|---|---|
| Search (검색) | 하나 이상의 인덱스에서 검색 쿼리를 실행해요. |
| Multi search (멀티 검색) | 단일 API 호출로 여러 검색 요청을 실행해요. |
| Search template (검색 템플릿) | 저장되거나 인라인 템플릿으로 검색을 실행해요. |
| Render search template (검색 템플릿 렌더링) | 파라미터로 검색 템플릿을 렌더링해요. |
| Explain search (검색 설명) | 쿼리 대비 문서 점수를 설명해요. |
| Get field capabilities (필드 기능 조회) | 인덱스 전체의 필드 기능을 반환해요. |
| Scroll search (스크롤 검색) | 대량의 결과를 효율적으로 가져와요(페이징). |
| Clear scroll (스크롤 초기화) | 스크롤 요청의 검색 컨텍스트를 지워요. |
Search application (검색 애플리케이션)
검색 애플리케이션 API는 Search Application 관련 작업·리소스를 관리할 수 있게 해줘요.
| API | 설명 |
|---|---|
| Create or update search application (검색 애플리케이션 생성/업데이트) | 검색 애플리케이션을 만들거나 업데이트해요. |
| Get search application (검색 애플리케이션 조회) | 이름으로 검색 애플리케이션을 가져와요. |
| Delete search application (검색 애플리케이션 삭제) | 검색 애플리케이션을 삭제해요. |
| Search search application (검색 애플리케이션 검색) | 검색 애플리케이션을 사용해 검색을 실행해요. |
Searchable snapshots (검색 가능한 스냅샷)
검색 가능한 스냅샷 API는 검색 가능한 스냅샷 작업을 수행할 수 있게 해줘요.
| API | 설명 |
|---|---|
| Mount searchable snapshot (검색 가능 스냅샷 마운트) | 스냅샷을 검색 가능한 인덱스로 마운트해요. |
| Clear searchable snapshot cache (스냅샷 캐시 초기화) | 검색 가능한 스냅샷의 캐시를 지워요. |
| Get searchable snapshot stats (스냅샷 통계 조회) | 검색 가능한 스냅샷에 대한 통계를 반환해요. |
Security (보안)
보안 API는 보안 활동을 수행하고, 애플리케이션 권한·역할 매핑·역할을 추가·업데이트·조회·제거할 수 있게 해줘요. API 키를 만들고 업데이트하거나, 베어러 토큰을 만들고 무효화할 수도 있어요.
| API | 설명 |
|---|---|
| Create or update user (사용자 생성/업데이트) | 네이티브 영역(realm)에 사용자를 만들거나 업데이트해요. |
| Get user (사용자 조회) | 하나 이상의 사용자를 가져와요. |
| Delete user (사용자 삭제) | 네이티브 영역에서 사용자를 삭제해요. |
| Create or update role (역할 생성/업데이트) | 역할을 만들거나 업데이트해요. |
| Get role (역할 조회) | 하나 이상의 역할을 가져와요. |
| Delete role (역할 삭제) | 역할을 삭제해요. |
| Create API key (API 키 생성) | 기본 인증 없이 접근할 수 있는 API 키를 만들어요. |
| Invalidate API key (API 키 무효화) | 하나 이상의 API 키를 무효화해요. |
| Authenticate (인증) | 인증된 사용자에 대한 정보를 가져와요. |
Snapshot and restore (스냅샷과 복원)
스냅샷과 복원 API는 스냅샷 레포지토리를 구성하고, 스냅샷 백업을 관리하며, 실행 중인 클러스터에 스냅샷을 복원할 수 있게 해줘요.
| API | 설명 |
|---|---|
| Clean up snapshot repository (레포지토리 정리) | 레포지토리에서 오래된 데이터를 제거해요. |
| Clone snapshot (스냅샷 복제) | 스냅샷의 인덱스를 새 스냅샷으로 복제해요. |
| Get snapshot (스냅샷 조회) | 스냅샷 정보를 가져와요. |
| Create snapshot (스냅샷 생성) | 하나 이상의 인덱스 스냅샷을 만들어요. |
| Delete snapshot (스냅샷 삭제) | 레포지토리에서 스냅샷을 삭제해요. |
| Get snapshot repository (레포지토리 조회) | 스냅샷 레포지토리 정보를 가져와요. |
| Create or update snapshot repository (레포지토리 생성/업데이트) | 스냅샷 레포지토리를 등록하거나 업데이트해요. |
| Delete snapshot repository (레포지토리 삭제) | 스냅샷 레포지토리를 삭제해요. |
| Restore snapshot (스냅샷 복원) | 스냅샷을 복원해요. |
| Analyze snapshot repository (레포지토리 분석) | 정확성과 성능을 위해 스냅샷 레포지토리를 분석해요. |
| Verify snapshot repository (레포지토리 검증) | 스냅샷 레포지토리에 대한 접근을 검증해요. |
| Get snapshot status (스냅샷 상태 조회) | 스냅샷의 상태를 가져와요. |
Snapshot lifecycle management (SLM, 스냅샷 라이프사이클 관리)
스냅샷 라이프사이클 관리 API는 스냅샷을 자동으로 찍고 보존 기간을 제어하는 정책을 구성할 수 있게 해줘요.
| API | 설명 |
|---|---|
| Get snapshot lifecycle policy (SLM 정책 조회) | 하나 이상의 스냅샷 라이프사이클 정책을 가져와요. |
| Create or update snapshot lifecycle policy (SLM 정책 생성/업데이트) | 스냅샷 라이프사이클 정책을 만들거나 업데이트해요. |
| Delete snapshot lifecycle policy (SLM 정책 삭제) | 스냅샷 라이프사이클 정책을 삭제해요. |
| Execute snapshot lifecycle policy (SLM 정책 실행) | 스냅샷 라이프사이클 정책을 수동으로 트리거해요. |
| Execute snapshot retention (보존 정책 실행) | 보존 정책을 수동 적용해 SLM 정책 보존 규칙에 따라 만료된 스냅샷을 즉시 제거해요. |
| Get snapshot lifecycle stats (SLM 통계 조회) | 스냅샷 라이프사이클 실행에 대한 통계를 반환해요. |
| Get snapshot lifecycle status (SLM 상태 조회) | 스냅샷 라이프사이클 관리 기능의 상태를 반환해요. |
| Start snapshot lifecycle management (SLM 시작) | 스냅샷 라이프사이클 관리 기능을 시작해요. |
| Stop snapshot lifecycle management (SLM 중지) | 스냅샷 라이프사이클 관리 기능을 중지해요. |
SQL
SQL API는 Elasticsearch 인덱스와 데이터 스트림에 SQL 쿼리를 실행할 수 있게 해줘요.
| API | 설명 |
|---|---|
| Clear SQL cursor (SQL 커서 정리) | SQL 검색의 서버측 커서를 지워요. |
| Delete async SQL search (비동기 SQL 검색 삭제) | 비동기 SQL 검색을 삭제해요. |
| Get async SQL search results (비동기 SQL 결과 조회) | 비동기 SQL 쿼리의 결과를 가져와요. |
| Get async SQL search status (비동기 SQL 상태 조회) | 비동기 SQL 검색 또는 저장된 동기 SQL 검색의 현재 상태를 가져와요. |
| SQL query (SQL 쿼리) | SQL 쿼리를 실행해요. |
| Translate SQL (SQL 변환) | SQL을 Elasticsearch DSL로 변환해요. |
Synonyms (동의어)
동의어 관리 API는 내부 시스템 인덱스에서 동의어를 정의하고 관리하는 편리한 방법을 제공해요. 관련 동의어는 "synonyms set"(동의어 세트)으로 묶을 수 있어요.
| API | 설명 |
|---|---|
| Get synonym set (동의어 세트 조회) | ID로 동의어 세트를 가져와요. |
| Create or update synonym set (동의어 세트 생성/업데이트) | 동의어 세트를 만들거나 업데이트해요. |
| Delete synonym set (동의어 세트 삭제) | 동의어 세트를 삭제해요. |
| Get synonym sets (동의어 세트 목록 조회) | 모든 동의어 세트를 나열해요. |
Task management (작업 관리)
작업 관리 API는 클러스터에서 실행 중인 작업에 대한 정보를 가져오거나 작업을 취소할 수 있게 해줘요.
| API | 설명 |
|---|---|
| Cancel a task (작업 취소) | 실행 중인 작업을 취소해요. |
| Get all tasks (전체 작업 조회) | 실행 중인 작업에 대한 정보를 가져와요. |
Text structure (텍스트 구조)
텍스트 구조 API는 Elasticsearch 인덱스의 텍스트 필드 구조를 찾을 수 있게 해줘요.
| API | 설명 |
|---|---|
| Find the structure of a text file (텍스트 파일 구조 분석) | 텍스트 파일을 분석해 그 구조를 반환해요. |
Transform (트랜스폼)
트랜스폼 API는 트랜스폼을 만들고 관리할 수 있게 해줘요.
| API | 설명 |
|---|---|
| Get transforms (트랜스폼 조회) | 하나 이상의 트랜스폼 구성을 가져와요. |
| Create a transform (트랜스폼 생성) | 트랜스폼 작업을 만들거나 업데이트해요. |
| Get transform stats (트랜스폼 통계 조회) | 트랜스폼 사용 정보를 가져와요. |
| Preview transform (트랜스폼 미리보기) | 트랜스폼 작업의 결과를 미리 봐요. |
| Reset a transform (트랜스폼 리셋) | 트랜스폼 작업을 리셋해요. |
| Delete transform (트랜스폼 삭제) | 트랜스폼 작업을 삭제해요. |
| Schedule a transform (트랜스폼 일정) | 트랜스폼 작업을 예약해요. |
| Start transform (트랜스폼 시작) | 트랜스폼 작업을 시작해요. |
| Stop transform (트랜스폼 중지) | 실행 중인 트랜스폼 작업을 중지해요. |
| Update transform (트랜스폼 업데이트) | 트랜스폼의 특정 속성을 업데이트해요. |
| Upgrade all transforms (전체 트랜스폼 업그레이드) | 트랜스폼의 특정 속성을 업데이트해요. |
Usage (사용 현황)
Usage API는 설치된 X-Pack 기능에 대한 사용 정보를 제공해요.
| API | 설명 |
|---|---|
| Get information (정보 조회) | 빌드 세부 정보, 라이선스 상태, 현재 라이선스에서 사용 가능한 기능 목록을 가져와요. |
| Get usage information (사용 정보 조회) | 현재 라이선스에서 활성화·사용 가능한 기능에 대한 정보를 가져와요. |
Watcher
Watcher로 데이터의 변화나 이상을 감시하고 그에 따른 필요한 조치를 수행할 수 있어요.
| API | 설명 |
|---|---|
| Acknowledge a watch (워치 확인) | 워치 액션을 확인(acknowledge)해요. |
| Activate a watch (워치 활성화) | 워치를 활성화해요. |
| Deactivate a watch (워치 비활성화) | 워치를 비활성화해요. |
| Get a watch (워치 조회) | ID로 워치를 가져와요. |
| Create or update a watch (워치 생성/업데이트) | 워치를 만들거나 업데이트해요. |
| Delete a watch (워치 삭제) | 워치를 삭제해요. |
| Run a watch (워치 실행) | 워치를 수동으로 실행해요. |
| Get Watcher index settings (Watcher 인덱스 설정 조회) | Watcher 내부 인덱스의 설정을 가져와요. |
| Update Watcher index settings (Watcher 인덱스 설정 업데이트) | Watcher 내부 인덱스의 설정을 업데이트해요. |
| Query watches (워치 쿼리) | 모든 등록된 워치를 페이지네이션 방식으로 가져오고, 선택적으로 쿼리로 워치를 필터링해요. |
| Start the watch service (Watcher 서비스 시작) | Watcher 서비스를 시작해요. |
| Get Watcher statistics (Watcher 통계 조회) | Watcher 서비스에 대한 통계를 반환해요. |
| Stop the watch service (Watcher 서비스 중지) | Watcher 서비스를 중지해요. |