_search API介绍

_search API 返回与请求中定义的查询匹配的搜索结果。

# API
GET /my-index-000001/_search

_search API有以下四种格式：

GET /<target>/_search

GET /_search

POST /<target>/_search

POST /_search

分别是get方式和post方式，<target> 路径参数 (可选，字符串)要搜索的数据流、索引和别名的逗号分隔列表。支持通配符(*)。如果要搜索所有数据流和索引，请忽略此参数或使用 * 或 _all。

例如，以下查询语句返回所有索引中的所有文档：

GET /_search
# 或
GET /_all/_search
# 或
GET /*/_search

您可以使用q查询字符串参数或request body提供搜索查询。如果同时指定两个参数，则只使用q查询字符串。

例如，同时指定了参数,查询字符串起作用（?后边的起作用）：

GET /kibana_sample_data_ecommerce/_search?size=2&from=0
{
  "size": 3,
  "from": 0
}

常用查询字符串（基于URL的请求）

请求参数名	说明
q	(可选，string)使用Lucene查询字符串语法进行查询。
from	(可选，整数)开始文档偏移。默认值为0。
size	(可选，整数)定义要返回的文档数量。默认为10。
sort	(可选，string)以逗号分隔的<字段>:<方向>对。
_source	(可选)指定匹配文档时返回哪些源字段。默认值：true,表示返回_source全部字段,false表示不返回_source字段

例如，要做分页查询,从0条开始，查询10条数据：

GET /kibana_sample_data_ecommerce/_search?from=0&size=10

例如，要使用订单日期做倒叙排序：

GET /kibana_sample_data_ecommerce/_search?sort=order_date:desc

例如，只返回订单id和订单时间字段：

# 只返回了一个结果
GET /kibana_sample_data_ecommerce/_search?size=1&from=0&_source=order_id,order_date
# 返回：
{
  "took" : 1,
  "timed_out" : false,
  "_shards" : {
    "total" : 1,
    "successful" : 1,
    "skipped" : 0,
    "failed" : 0
  },
  "hits" : {
    "total" : {
      "value" : 4675,
      "relation" : "eq"
    },
    "max_score" : 1.0,
    "hits" : [
      {
        "_index" : "kibana_sample_data_ecommerce",
        "_type" : "_doc",
        "_id" : "8v__-HwB4yTyXQY6tGFu",
        "_score" : 1.0,
        "_source" : {
          "order_date" : "2021-11-22T09:28:48+00:00",
          "order_id" : 584677
        }
      }
    ]
  }
}

例如，返回customer_first_name是Youssef的订单：

GET /kibana_sample_data_ecommerce/_search?q=customer_first_name:Youssef

常用的请求体字段（基于请求体的请求）

请求体字段名	说明
query	(可选，查询对象)使用query DSL定义搜索。
from	(可选，整数)开始文档偏移。默认值为0。
size	(可选，整数)定义要返回的文档数量。默认为10。
sort	(可选，对象数组)“sort”: [{“FIELD”: { “order”: “desc”}}] ,FIELD是字段。order属性有asc、desc
_source	1. (可选)指定匹配文档时返回哪些源字段。 2.默认值：true,表示返回_source全部字段,false表示不返回_source字段； 3.还支持通配符（字符串或字符串数组）； 4.支持传一个对象，该对象有俩个属性，excludes和includes，排除字段和包含哪些字段， excludes和includes字段的值是通配符模式的字符串或数组

例如，返回以order_开头的字段，以及customer_full_name字段：

POST /kibana_sample_data_ecommerce/_search
{
  "query": {
    "match_all": {}
  },
  "_source": ["order_*", "customer_full_name"]
}

例如，返回以customer_开头的字段，以及order_id，但不要返回customer_full_name字段：

POST /kibana_sample_data_ecommerce/_search
{
  "query": {
    "match_all": {}
  },
  "_source": {
    "includes": ["customer_*", "order_id"],
    "excludes": "customer_full_name"
  }
}
# 返回
{
  "took" : 2,
  "timed_out" : false,
  "_shards" : {
    "total" : 1,
    "successful" : 1,
    "skipped" : 0,
    "failed" : 0
  },
  "hits" : {
    "total" : {
      "value" : 4675,
      "relation" : "eq"
    },
    "max_score" : 1.0,
    "hits" : [
      {
        "_index" : "kibana_sample_data_ecommerce",
        "_type" : "_doc",
        "_id" : "8v__-HwB4yTyXQY6tGFu",
        "_score" : 1.0,
        "_source" : {
          "customer_last_name" : "Underwood",
          "customer_first_name" : "Eddie",
          "customer_phone" : "",
          "customer_id" : 38,
          "order_id" : 584677,
          "customer_gender" : "MALE"
        }
      }
      ...
    ]
  }
}

例如，根据订单日期倒叙排序，订单id升序排序：

POST /kibana_sample_data_ecommerce/_search
{
  "query": {
    "match_all": {}
  },
  "sort": [
    {
      "order_date": {
        "order": "desc"
      }
    },
    {
      "order_id": {
        "order": "asc"
      }
    }
  ]
}

请求响应体介绍

响应体字段名	说明
took	(整数)Elasticsearch执行请求所花费的毫秒数。
timed_out	(Boolean)如果为真，则请求在完成之前超时;返回的结果可能是部分的或空的。
_shards	(object)包含请求所使用的shards的计数。
hits	(object)包含返回的文档和元数据。
hits.total	(object)关于返回文档数量的元数据。
hits.total.value	(整数)返回的文档总数。
hits.total.relation	(string)指示value参数中返回的文档数量是准确的还是一个下限。eq准确的，gte下界
hits.max_score	文档中的最大得分。

GET /kibana_sample_data_ecommerce/_search?size=1&from=0&_source=order_id,order_date
# 请求响应体
{
  "took" : 3,
  "timed_out" : false,
  "_shards" : {
    "total" : 1,
    "successful" : 1,
    "skipped" : 0,
    "failed" : 0
  },
  "hits" : {
    "total" : {
      "value" : 4675,
      "relation" : "eq"
    },
    "max_score" : 1.0,
    "hits" : [
      {
        "_index" : "kibana_sample_data_ecommerce",
        "_type" : "_doc",
        "_id" : "8v__-HwB4yTyXQY6tGFu",
        "_score" : 1.0,
        "_source" : {
          "order_date" : "2021-11-22T09:28:48+00:00",
          "order_id" : 584677
        }
      }
    ]
  }
}