다음 options들은 모든 REST API에 적용할 수 있다.

Pretty Results

Request의 말미에 ?pretty=true를 추가했을 때는 JSON이 예쁜 형태로 리턴된다. (단지 디버깅 목적으로만 사용하라!) 또다른 옵션으로 ?format=yaml로 설정하면 더 읽기 쉬운 yaml 형태로 결과가 리턴될 것이다.

Human Readable Output

통계는 사람에게 적합한 형태 (예를 들어 "exist_time":"1h" or "size":"1kb")와 컴퓨터에게 적합한 형태 (예를 들어 "exists_time_in_millis": 3600000 or "size_in_bytes": 1024)로 리턴된다. 사람이 읽기에 적합한 형태의 값들은 query string에 ?human=false를 추가하여 기능을 끌 수 있다. 이것은 통계 결과가 사람보다는 모니터링 툴에 의해 다루어질 때 의미가 있다. 기본적으로 human flag는 false이다.

Flat Settings

Flat_settings flag는 설정값들을 제시하는 효과가 있다. Flag_settigns값이 true일 때, 설정값들이 flat format 형태로 리턴된다.

{
  "persistent" : { },
  "transient" : {
   "discovery.zen.minimum_master_nodes" : "1"
  }
}

Flat_settings가 false일 때, 설정값들은 좀 더 사람이 읽을 수 있는 구조화된 형태로 리턴된다.

{
  "persistent" : { },
  "transient" : {
   "discovery" : {
     "zen" : {
       "minimum_master_nodes" : "1"
     }
   }
  }
}

기본적으로 flat_settings 값은 false이다.

Parameters

REST parameter들(HTTP를 사용할 때, HTTP URL에 사용되는 parameter들)은 underscore를 사용한다. (underline 사용)

Boolean Values

모든 REST API parameter들은 (request parameter와 JSON body) boolean "false"에 해당하는 값으로 false, 0, no, off를 사용할 수 있다. 그 이외 다른 값들은 모두 "true"로 간주한다. Index된 document내에서 boolean field를 다루는 것과는 아무 상관이 없다는 것에 유의하라. (단지 request parameter와 json body에서만 이렇게 다룬다는 뜻임.)

Number Values

모든 REST API는 JSON number type 뿐만 아니라 string으로 number 값을 표시하는 것을 지원한다.

Time Units

Duration이 필요할 경우, 예를 들어 timeout parameter이 경우에 duration은 밀리초를 나타내는 숫자로 표시할 수 있다. 혹은 2일의 경우 2d와 같이 표시할 수도 있다. 지원되는 단위는 다음과 같다.

y : Year

M : Month

w : Week

d : Day

h : Hour

m : Minute

s : Second

Index parameter를 가리키는 대부분의 API는 간단히 test1, test2, test3 notation을 사용하여 (혹은 모든 index에 대해서는 _all) 여러 index에 걸쳐 실행될 수 있다. 물론 wildcard도 지원한다. 예를 들어 test*와 같이 사용할 수도 있다. 또한 +기호를 추가의 의미로, -기호를 삭제의 의미로 사용할 수도 있다. 예를 들어 +test*, -test3과 같이 사용할 수 있다.

모든 multiple indices API는 다음과 같은 url에 사용되는 string parameter를 지원한다.

• Ignore_unavailable : 특정 index가 사용불가능하다면 무시하도록 한다. 존재하지 않거나 closed index에 대해서도 적용할 수 있다. 값은 true | false를 갖는다.
• Allow_no_indices : wildcard index 표현에 맞는 index 결과가 없다면 실패라고 설정한다. True나 false값을 가질 수 있다. 예를 들어, wildcard 표현으로 foo*에 해당하는 index가 없다면 이 요청에 대해서는 fail일 것이다. 이 설정은 또한 _all, *, index가 전혀 없을 때도 적용할 수 있다. 또한 Closed index에 대한 Alias에도 적용할 수 있다.

• Expand_wildcards : 어떤 종류의 구체적인 index에 대해서도 wildcard index 표현을 확장할 수 있다. 예를 들어 open이라고 사용하면, wildcard 표현은 단지 open index에 대해서만 확장된다. 반대로 closed가 사용되면 wildcard 표현은 단지 closed index에만 확장된다. 또한 모든 index에 대해서 두가지 (open, closed) 모두 사용할 수도 있다.

만약 none을 사용하면 wildcard 표현은 사용할 수 없다. All의 경우에는 모든 index에 대해서 wildcard 표현을 사용할 수 있다.

위 parameter의 기본 설정은 사용되는 api에 달려 있다.

[NOTE]

Document API (http://www.elastic.co/guide/en/elasticsearch/reference/current/docs.html) 와 single-index alias API (http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html) 와 같은 Single Index API는 multiple index를 지원하지 않는다.