<div id="readability-page-1" class="page"><div>
 <a href="/m/category/ElasticSearch/ElasticSearch">ElasticSearch/ElasticSearch</a><h2>elasticSearch 7.10 REST API spec</h2>
 <cite>
 DarrenKwonDev
 </cite>
 </div><time>2021. 9. 18. 21:29</time>
 
 
 <a href="#comment" onclick="Utils.smoothScroll(this);return false">
 
 </a>
 
 
 
 
 
 
 
 <div>
 api specification 좀 깔끔히 정리해주면 덧나나. 정말로 찾기가 힘들다.
7 버전으로 올라오면서 좀 나아지긴 했다.
<figure data-origin-width="589" data-origin-height="113" data-ke-mobilestyle="widthOrigin"><img src="https://blog.kakaocdn.net/dn/WBiiD/btre6DR86ng/kKzumkPOMjbyz2YlMn8oD0/img.png" data-origin-width="589" data-origin-height="113" data-ke-mobilestyle="widthOrigin"><figcaption>https://logz.io/blog/elasticsearch-api/</figcaption></figure>


<h4 data-ke-size="size20">Cluster APIs</h4>
<a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cluster.html" target="_blank" rel="noopener">https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cluster.html</a>


cluster health
<a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cluster-health.html" target="_blank" rel="noopener">https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cluster-health.html</a>
<pre id="code_1631948290721" data-ke-language="javascript" data-ke-type="codeblock"><code>GET /_cluster/health/&lt;target&gt;</code></pre>

node stats
<a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cluster-nodes-stats.html" target="_blank" rel="noopener">https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cluster-nodes-stats.html</a>
<pre id="code_1631949138542" data-ke-language="javascript" data-ke-type="codeblock"><code>GET /_nodes/stats
GET /_nodes/&lt;node_id&gt;/stats // &lt;node_id&gt; Comma-separated list of node IDs or names</code></pre>

<h4 data-ke-size="size20">index APIs(과거명 : indicies APIs)</h4>
<a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.10/indices.html" target="_blank" rel="noopener">https://www.elastic.co/guide/en/elasticsearch/reference/7.10/indices.html</a>
* 참고로 논리적인 document의 구분자들은 indicies, document를 특정 index에 저장(분류)하는 행위는 indexing이라고 합니다.
우리는 index를 생성한 다음 해당 index에 document를 넣는 indexing(색인) 작업을 할 것입니다.
작업순서로 보면 index(indicies)생성 -&gt; document를 특정 index에 저장(indexing)

create index
<a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.10/indices-create-index.html" target="_blank" rel="noopener">https://www.elastic.co/guide/en/elasticsearch/reference/7.10/indices-create-index.html</a>
<pre id="code_1631951502484" data-ke-language="javascript" data-ke-type="codeblock"><code>PUT /&lt;index&gt;</code></pre>


<h4 data-ke-size="size20">Document APIs</h4>
<a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.10/docs.html#docs" target="_blank" rel="noopener">https://www.elastic.co/guide/en/elasticsearch/reference/7.10/docs.html#docs</a>
* Document APIs 내부에&nbsp; 다양한 api들이 존재하는데, Index api, delete api와 같이 단순히 document를 CRUD하는 api부터 bulk api 등 multi-document를 다루는 api도 존재함.

index api&nbsp;
<a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.10/docs-index_.html" target="_blank" rel="noopener">https://www.elastic.co/guide/en/elasticsearch/reference/7.10/docs-index_.html</a>
* 당연하겠지만 여기서의 index는 indexing, 즉, document 저장을 의미한다.
* 만약, indexing하고자 하는 데이터가 고유한 id를 이미 가지고 있는 경우 식별자 필드를 그대로 id로 넣어주는 것이 편리하다! 즉, DB Record의 식별자 키를 elasticSearch의 실제 키로 사용하는 것이 좋다는 말이다.
* id를 직접 부여할 경우 PUT 메서드, 자동 id 부여는 POST 메서드를 사용한다.
* 같은 id를 가진 document를 PUT하게 되면 오류가 발생하는 것이 아니라 기존 document는 overwritten되는 방식으로 update 되며, 결과값 필드 중 _version이 올라가는 것을 확인할 수 있다.
* 생성, 수정, 삭제시 해당 id의 _version이 올라간다. 자세한 내용은 <a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.10/docs-index_.html#index-versioning" target="_blank" rel="noopener">versioning</a>
* document가 바뀌지 않더라도 언제나 새로운 버전의 document가 생성된다. 자세한 내용은&nbsp;<a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.10/docs-index_.html#index-noop" target="_blank" rel="noopener">noop update</a>
<pre id="code_1631952905401" data-ke-language="javascript" data-ke-type="codeblock"><code>PUT /&lt;target&gt;/_doc/&lt;_id&gt; // natural_identifier가 존재한다면 이 녀석을 id로 설정하자
POST /&lt;target&gt;/_doc/ // Automatic ID generation. natural_identifier가 없는 경우 편함</code></pre>

만약 indexing하는 과정 중 기존에 존재하는 id가 같아 document를 overwrite하고 싶지 않다면, operation type을 create로 명시해주면 된다. 이것도 elasticSearch 버전마다 표기법이 달라져서 쬐끔 번거로운 면이 있다.
<blockquote data-ke-style="style2">_create guarantees that the document is only indexed if it does not already exist.&nbsp;- https://www.elastic.co/guide/en/elasticsearch/reference/7.10/docs-index_.html#docs-index-api-desc</blockquote>
만약, 해당 id에 이미 도큐먼트가 존재한다면 version_conflict_engine_exception 에러를 발생시킨다.&nbsp;
<pre id="code_1631955323459" data-ke-language="javascript" data-ke-type="codeblock"><code>PUT /&lt;target&gt;/_create/&lt;_id&gt;
POST /&lt;target&gt;/_create/&lt;_id&gt;</code></pre>


get api
<a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.10/docs-get.html" target="_blank" rel="noopener">https://www.elastic.co/guide/en/elasticsearch/reference/7.10/docs-get.html</a>
* CRUD로 치면 Read에 해당하는 부분이다.
<pre id="code_1631953963796" data-ke-language="javascript" data-ke-type="codeblock"><code>GET &lt;index&gt;/_doc/&lt;_id&gt;</code></pre>


update api
<a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.10/docs-update.html" target="_blank" rel="noopener">https://www.elastic.co/guide/en/elasticsearch/reference/7.10/docs-update.html</a>
<pre id="code_1631967046324" data-ke-language="javascript" data-ke-type="codeblock"><code>// update_part_of_a_document. 즉, 추가적인 부분만 업데이트 되지, overwrite하는 것이 아님.
POST /&lt;index&gt;/_update/&lt;_id&gt; 
{
 "doc": { ... }
}</code></pre>

delete api
<a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.10/docs-delete.html" target="_blank" rel="noopener">https://www.elastic.co/guide/en/elasticsearch/reference/7.10/docs-delete.html</a>
<pre id="code_1631967696910" data-ke-language="javascript" data-ke-type="codeblock"><code>DELETE /&lt;index&gt;/_doc/&lt;_id&gt;</code></pre>


 
 
					
 
 
 </div></div>

HotHandCoding

DarrenKwon

api specification 좀 깔끔히 정리해주면 덧나나. 정말로 찾기가 힘들다.
7 버전으로 올라오면서 좀 나아지긴 했다.
 
 
Cluster APIs
https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cluster.html
 
 
cluster health
https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cluster-health.html
GET /_cluster/health/<target>
 
node stats
https://www.elastic.co/guide/en/elasticsearch/reference/7.10/cluster-nodes-stats.html
GET /_nodes/stats
GET /_nodes/<node_id>/stats // <node_id> Comma-separated list of node IDs or names
 
index APIs(과거명 : indicies APIs)
https://www.elastic.co/guide/en/elasticsearch/reference/7.10/indices.html
* 참고로 논리적인 document의 구분자들은 indicies, document를 특정 index에 저장(분류)하는 행위는 indexing이라고 합니다.
우리는 index를 생성한 다음 해당 index에 document를 넣는 indexing(색인) 작업을 할 것입니다.
작업순서로 보면 index(indicies)생성 -> document를 특정 index에 저장(indexing)
 
create index
https://www.elastic.co/guide/en/elasticsearch/reference/7.10/indices-create-index.html
PUT /<index>
 
 
Document APIs
https://www.elastic.co/guide/en/elasticsearch/reference/7.10/docs.html#docs
* Document APIs 내부에  다양한 api들이 존재하는데, Index api, delete api와 같이 단순히 document를 CRUD하는 api부터 bulk api 등 multi-document를 다루는 api도 존재함.
 
index api 
https://www.elastic.co/guide/en/elasticsearch/reference/7.10/docs-index_.html
* 당연하겠지만 여기서의 index는 indexing, 즉, document 저장을 의미한다.
* 만약, indexing하고자 하는 데이터가 고유한 id를 이미 가지고 있는 경우 식별자 필드를 그대로 id로 넣어주는 것이 편리하다! 즉, DB Record의 식별자 키를 elasticSearch의 실제 키로 사용하는 것이 좋다는 말이다.
* id를 직접 부여할 경우 PUT 메서드, 자동 id 부여는 POST 메서드를 사용한다.
* 같은 id를 가진 document를 PUT하게 되면 오류가 발생하는 것이 아니라 기존 document는 overwritten되는 방식으로 update 되며, 결과값 필드 중 _version이 올라가는 것을 확인할 수 있다.
* 생성, 수정, 삭제시 해당 id의 _version이 올라간다. 자세한 내용은 versioning
* document가 바뀌지 않더라도 언제나 새로운 버전의 document가 생성된다. 자세한 내용은 noop update
PUT /<target>/_doc/<_id> // natural_identifier가 존재한다면 이 녀석을 id로 설정하자
POST /<target>/_doc/ // Automatic ID generation. natural_identifier가 없는 경우 편함
 
만약 indexing하는 과정 중 기존에 존재하는 id가 같아 document를 overwrite하고 싶지 않다면, operation type을 create로 명시해주면 된다. 이것도 elasticSearch 버전마다 표기법이 달라져서 쬐끔 번거로운 면이 있다.
_create guarantees that the document is only indexed if it does not already exist. - https://www.elastic.co/guide/en/elasticsearch/reference/7.10/docs-index_.html#docs-index-api-desc
만약, 해당 id에 이미 도큐먼트가 존재한다면 version_conflict_engine_exception 에러를 발생시킨다. 
PUT /<target>/_create/<_id>
POST /<target>/_create/<_id>
 
 
get api
https://www.elastic.co/guide/en/elasticsearch/reference/7.10/docs-get.html
* CRUD로 치면 Read에 해당하는 부분이다.
GET <index>/_doc/<_id>
 
 
update api
https://www.elastic.co/guide/en/elasticsearch/reference/7.10/docs-update.html
// update_part_of_a_document. 즉, 추가적인 부분만 업데이트 되지, overwrite하는 것이 아님.
POST /<index>/_update/<_id> 
{
 "doc": { ... }
}
 
delete api
https://www.elastic.co/guide/en/elasticsearch/reference/7.10/docs-delete.html
DELETE /<index>/_doc/<_id>

elasticSearch 7.10 REST API spec

댓글