Elasticsearch - API 约定

---

Web 中的应用程序编程接口 (API) 是一组函数调用或其他编程指令，用于访问特定 Web 应用程序中的软件组件。例如，Facebook API帮助开发人员通过访问Facebook的数据或其他功能来创建应用程序；它可以是出生日期或状态更新。

Elasticsearch 提供 REST API，可通过 HTTP 上的 JSON 进行访问。Elasticsearch 使用一些我们现在将讨论的约定。

多重指数

API中的大部分操作，主要是搜索等操作，都是针对一个或多个索引的。这有助于用户只需执行一次查询即可在多个位置或所有可用数据中进行搜索。许多不同的符号用于在多个索引中执行操作。我们将在本章中讨论其中的一些。

逗号分隔符号

POST /index1,index2,index3/_search

请求正文

{
   "query":{
      "query_string":{
         "query":"any_string"
      }
   }
}

回复

来自index1、index2、index3的JSON对象，其中包含any_string。

_all 所有指数的关键字

POST /_all/_search

请求正文

{
   "query":{
      "query_string":{
         "query":"any_string"
      }
   }
}

回复

来自所有索引并包含 any_string 的 JSON 对象。

通配符（*、+、–）

POST /school*/_search

请求正文

{
   "query":{
      "query_string":{
         "query":"CBSE"
      }
   }
}

回复

来自所有索引的 JSON 对象，这些索引以包含 CBSE 的 school 开头。

或者，您也可以使用以下代码 -

POST /school*,-schools_gov /_search

请求正文

{
   "query":{
      "query_string":{
         "query":"CBSE"
      }
   }
}

回复

来自所有以“school”开头但不来自 school_gov 且包含 CBSE 的索引的 JSON 对象。

还有一些 URL 查询字符串参数 -

• ignore_unavailable - 如果 URL 中存在的一个或多个索引不存在，则不会发生错误或不会停止任何操作。例如，schools 索引存在，但 book_shops 不存在。

POST /school*,book_shops/_search

请求正文

{
   "query":{
      "query_string":{
         "query":"CBSE"
      }
   }
}

请求正文

{
   "error":{
      "root_cause":[{
         "type":"index_not_found_exception", "reason":"no such index",
         "resource.type":"index_or_alias", "resource.id":"book_shops",
         "index":"book_shops"
      }],
      "type":"index_not_found_exception", "reason":"no such index",
      "resource.type":"index_or_alias", "resource.id":"book_shops",
      "index":"book_shops"
   },"status":404
}

考虑以下代码 -

POST /school*,book_shops/_search?ignore_unavailable = true

请求正文

{
   "query":{
      "query_string":{
         "query":"CBSE"
      }
   }
}

响应（无错误）

来自所有索引的 JSON 对象，这些索引以包含 CBSE 的 school 开头。

允许无索引

如果带有通配符的 URL 没有索引，则此参数的true值将防止错误。例如，没有以 school_pri 开头的索引 -

POST /schools_pri*/_search?allow_no_indices = true

请求正文

{
   "query":{
      "match_all":{}
   }
}

响应（无错误）

{
   "took":1,"timed_out": false, "_shards":{"total":0, "successful":0, "failed":0},
   "hits":{"total":0, "max_score":0.0, "hits":[]}
}

扩展通配符

该参数决定通配符是否需要扩展为开放索引或封闭索引或两者都执行。该参数的值可以是打开和关闭或者无和全部。

例如，关闭索引学校 -

POST /schools/_close

回复

{"acknowledged":true}

考虑以下代码 -

POST /school*/_search?expand_wildcards = closed

请求正文

{
   "query":{
      "match_all":{}
   }
}

回复

{
   "error":{
      "root_cause":[{
         "type":"index_closed_exception", "reason":"closed", "index":"schools"
      }],
      "type":"index_closed_exception", "reason":"closed", "index":"schools"
   }, "status":403
}

索引名称中的日期数学支持

Elasticsearch 提供了根据日期和时间搜索索引的功能。我们需要以特定格式指定日期和时间。例如，accountdetail-2015.12.30，索引将存储 2015 年 12 月 30 日的银行帐户详细信息。可以执行数学运算来获取特定日期或日期和时间范围的详细信息。

日期数学索引名称的格式 -

<static_name{date_math_expr{date_format|time_zone}}>
/<accountdetail-{now-2d{YYYY.MM.dd|utc}}>/_search

static_name 是表达式的一部分，在每个日期数学索引（如帐户详细信息）中保持相同。date_math_expr 包含像 now-2d 一样动态确定日期和时间的数学表达式。date_format 包含在索引中写入日期的格式，如 YYYY.MM.dd。如果今天的日期是 2015 年 12 月 30 日，则 <accountdetail-{now-2d{YYYY.MM.dd}}> 将返回 accountdetail-2015.12.28。

我们现在将看到 Elasticsearch 中可用的一些常用选项，可用于获取指定格式的响应。

漂亮的结果

我们只需附加一个 URL 查询参数即可获得格式良好的 JSON 对象的响应，即 Pretty = true。

POST /schools/_search?pretty = true

请求正文

{
   "query":{
      "match_all":{}
   }
}

回复

……………………..
{
   "_index" : "schools", "_type" : "school", "_id" : "1", "_score" : 1.0,
   "_source":{
      "name":"Central School", "description":"CBSE Affiliation",
      "street":"Nagan", "city":"paprola", "state":"HP", "zip":"176115",
      "location": [31.8955385, 76.8380405], "fees":2000,
      "tags":["Senior Secondary", "beautiful campus"], "rating":"3.5"
   }
}
………………….

人类可读的输出

此选项可以将统​​计响应更改为人类可读形式（如果人类 = true）或计算机可读形式（如果人类 = false）。例如，当响应需要由另一个计算机程序使用时，如果 human = true，则 distance_kilometer = 20KM，如果 human = false，则 distance_meter = 20000。

响应过滤

我们可以通过在 field_path 参数中添加更少的字段来过滤响应。例如，

POST /schools/_search?filter_path = hits.total

请求正文

{
   "query":{
      "match_all":{}
   }
}

回复

{"hits":{"total":3}}