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"
      }
   }
}

响应

所有以学校开头且包含 CBSE 的索引中的 JSON 对象。

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

POST /school*,-schools_gov /_search

请求主体

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

响应

所有以"school"开头但不来自 schools_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"
      }
   }
}

响应（无错误）

所有以 school 开头的索引中的 JSON 对象，其中包含 CBSE。

allow_no_indices

true 此参数的值将防止出现错误，如果带通配符的 URL 导致没有索引。例如，没有以 schools_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":[]}
}

expand_wildcards

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

例如，封闭索引学校 −

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 查询参数（即 pretty = true）即可​​以格式良好的 JSON 对象获取响应。

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"
   }
}
………………….

人类可读输出

此选项可以将统​​计响应更改为人类可读形式（如果 human = true）或计算机可读形式（如果 human = 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}}