요청에 정의된 쿼리와 일치하는 검색 hits를 반환한다.
Request
GET /<index>/_search
POST /<index>/_search
GET /_search
POST /_search
설명
검색 쿼리를 수행하고 쿼리와 일치하는 검색 hits를 가져올 수 있다. 쿼리는 단순한 쿼리 문자열을 매개 변수로 사용하거나 request body를 사용하여 제공할 수 있다.
Path parameters
<index>
(선택사항, String) 요청을 제한하는데 사용되는 쉼표로 구분된 목록 또는 와일드카드 표현의 인덱스 이름
Query parameters
allow_no_indices
(선택사항, Boolean) true인 경우, 와일드카드 표현식 또는 _all 값이 누락되거나 닫힌 인덱스만 검색하는 경우 요청은 오류를 반환하지 않는다.
이 파라미터는 누락되거나 닫힌 인덱스를 가르키는 인덱스 alias에도 적용 된다.
allow_partial_search_results
(선택사항, Boolean) 부분 검색 실패 또는 시간 초과가 있는 경우 오류를 반환할지 여뷰를 표시한다. 기본값은 true
analyzer
(선택사항, Boolean) true일 경우 와일드카드와 접두가 쿼리도 분석된다. 기본값은 false
batched_reduce_size
(선택사항, Integer) coordinating node에서 한번에 줄여야 하는 샤드 결과의 수이다. 이 값은 요청의 잠재적인 샤드 수가 클 수 있는 경우 검색 요청당 메모리 오버헤드를 줄이기 위한 보호 메커니즘으로 사용해야 한다. 기본값은 512
ccs_minimize_roundtrips
(선택사항, Boolean) 크로스 클러스터 검색 요청 실행의 일부로 네트워크 라운드 트립을 최소화해야 하는지 여부를 표시한다. 기본값은 true
default_operator
(선택사항, String) 쿼리 문자열 조회에 대한 기본 연산자(AND 또는 OR). 기본값은 OR
df
(선택사항, Boolean) 쿼리 문자열에 필드 접두사가 지정되지 않은 경우 기본값으로 사용할 필드를 정의한다.
docvalue_fileds
(선택사항, String) 각 hit 필드에 대한 문서 값 표현으로 반환할 쉼표로 구분된 필드 목록
expand_wildcards
(선택사항, String) 와일드카드 식이 확장될 수 있는 인덱스의 종류를 제어한다. 유효한 값은 다음과 같다.
all
open 및 closed 인덱스로 확장
open
open로 인덱스 확장
closed
closed로 인덱스 확장
none
와일드카드 표현이 허용되지 않음
기본값은 open 이다.
explain
(선택사항, Boolean) true일 경우, hit의 일부로 점수 계산에 대한 자세한 정보를 반환한다. 기본값은 false
from
(선택사항, Integer) 시작 offset를 지정한다. 기본값은 0
ignore_throttled
(선택사항, Boolean) true일 경우, throttle 시 실체화, 확장 또는 aliased화 된 인덱스는 무시된다.
ignore_unavailable
(선택사항, Boolean) true일 경우, 누락되거나 closed된 인덱스는 응답에 포함되지 않는다. 기본값은 false
lenient
(선택사항, Boolean) true일 경우, 형식 기반 쿼리실패는 무시된다.(예: 숫자 필드에 텍스트 입력) 기본값은 false
max_concurrent_shard_requests
(선택사항, Integer) 검색이 동시에 실행되는 노드 당 동시 샤드 요청수를 정의한다. 이 값은 동시 샤드 요청수를 제한하기 위해 검색이 클러스터에 미치는 영향을 제한하기 위해 사용한다. 기본 값은 5
pre_filter_shard_size
(선택사항, Integer) 검색 요청에 의해 샤드 수가 임계 값을 초과하는 경우 쿼리 재작성에 따라 검색 샤드를 사전 필터링 하도록 사전 필터왕복을 강제하는 임계 값을 정의한다. 샤드가 다시쓰기 방법에 따라 문서와 일치할 수 없는 경우 이 필터왕복은 샤드 수를 크게 제한 할 수있다. 예를 들어 날짜 필터가 일치해야 하지만 샤드 경계와 쿼리가 분리되어 있는 경우가 있다. 기본 값은 128
preference
(선택사항, String) 작업을 수행할 노드 또는 샤드 지정. 기본값은 랜덤
q
(선택사항, String) Lucene 쿼리 문자열 구문에서의 쿼리
request_cache
(선택사항, Boolean) true일 경우, Request에 request cache가 사용된다. 기본값은 인덱스 수준의 설정
rest_total_hits_as_int
(선택사항, Boolean) hits.total을 나머지 검색 응답에서 정수 또는 오브젝트로 렌더링해야 하는지 여부를 나타낸다. 기본 값은 false
routing
(선택사항, time units) 스크롤된 검색을 위해 인덱스의 일관된 보기를 유기할 기간을 지정
search_type
(선택사항, String) 검색 작업의 유형을 정의한다. 사용 가능한 옵션은 다음과 같다.
- query_then_fetch
- dfs_query_then_fetch
seq_no_primary_term
(선택사항, Boolean) true일 경우, 각 hit의 마지막 수정에 대한 시퀀스 번호와 기본 기간을 반환한다.
size
(선택사항, Integer) 반환할 hits 수를 정의한다. 기본값은 10
sort
(선택사항, String) 쉼표로 구분된 <field>:<direction> 쌍 목록
_source
(선택사항, String) _source 필드를 반환하거나 반환할 필드 목록을 반환하려면 True 또는 False
_source_excludes
(선택사항, String) 반환된 _source 필드에서 제외할 필드 목록
_source_includes
(선택사항, String) _source 필드에서 추출하여 반환할 필드 목록
stats
(선택사항, String) 로깅 및 통계 목적을 위한 요청의 특정 태그
stored_fields
(선택사항, String) hit의 일부로 반환할 쉼표로 구분된 저장된 필드 목록
suggest_field
(선택사항, String) 제안에 사용할 필드를 지정
suggest_mode
(선택사항, String) 제안 모드를 지정. 기본값은 공란이며 사용가능한 옵션은 다음과 같다.
- always
- missing
- popular
suggest_size
(선택사항, Integer) 응답으로 반환 할 제안 수를 정의
suggest_text
(선택사항, String) 반환되어야 하는 제안의 원본 텍스트
terminate_after
(선택사항, Integer) 쿼리 실행이 조기에 종료될 떄 각 샤드에 대해 수집할 최대 문서 수
timeout
(선택사항, time units) 응답을 기다릴 시간을 지정한다. 시간 초과가 만료되기전에 응답이 수신되지 않으면 요청이 실패하고 오류가 반환된다. 기본값은 30초
track_scores
(선택사항, Boolean) true인 경우, 정렬에 사용되지 않더라도 score를 계산하여 반환한다.
track_total_hits
(선택사항, Boolean) 질의와 일치하는 문서 수를 추적해야 하는지 여부를 표시한다.
typed_keys
(선택사항, Boolean) 응답에서 집계 및 제안자 이름 앞에 해당 유형을 붙여야 하는지 여부를 지정
version
(선택사항, Boolean) true인 경우, hit의 일부로 문서 버전을 반환
Request body
query
(선택사항, query object) 쿼리 DSL을 사용하여 검색 정의를 정의