Elasticsearch基本操作-RESTful操作1

2023-08-01 106

版权

本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。

本文涉及的产品

RDS MySQL Serverless 基础系列，0.5-2RCU 50GB

云数据库 RDS MySQL，集群版 2核4GB 100GB

检索分析服务 Elasticsearch 版，2核4GB开发者规格 1个月

简介： Elasticsearch基本操作-RESTful操作

1. RESTful介绍

RESTful介绍

REST 指的是一组架构约束条件和原则。满足这些约束条件和原则的应用程序或设计就是 RESTful。Web 应用程序最重要的 REST 原则是，客户端和服务器之间的交互在请求之间是无状态的。从客户端到服务器的每个请求都必须包含理解请求所必需的信息。如果服务器在请求之间的任何时间点重启，客户端不会得到通知。此外，无状态请求可以由任何可用服务器回答，这十分适合云计算之类的环境。客户端可以缓存数据以改进性能。

在服务器端，应用程序状态和功能可以分为各种资源。资源是一个有趣的概念实体，它向客户端公开。资源的例子有：应用程序对象、数据库记录、算法等等。每个资源都使用 URI(Universal Resource Identifier) 得到一个唯一的地址。所有资源都共享统一的接口，以便在客户端和服务器之间传输状态。使用的是标准的 HTTP 方法，比如 GET、PUT、POST 和DELETE。

在 REST 样式的 Web 服务中，每个资源都有一个地址。资源本身都是方法调用的目标，方法列表对所有资源都是一样的。这些方法都是标准方法，包括 HTTP GET、POST、PUT、DELETE，还可能包括 HEAD 和OPTIONS。简单的理解就是，如果想要访问互联网上的资源，就必须向资源所在的服务器发出请求，请求体中必须包含资源的网络路径，以及对资源进行的操作(增删改查)。

2. 客户端安装

如果直接通过浏览器向 Elasticsearch 服务器发请求，那么需要在发送的请求中包含HTTP 标准的方法，而 HTTP 的大部分特性且仅支持 GET 和 POST 方法。所以为了能方便地进行客户端的访问，可以使用 Postman（不支持中文但用的人相对较多），Apipost（中国人做的），Apifox（中国人做的）等api调试工具。

Postman：https://www.postman.com/downloads/

Apipost：https://www.apipost.cn//

Apifox：https://www.apifox.cn/

Postman：老牌且强大的网页调试工具，界面简洁明晰、操作方便快捷，设计得很人性化。但是不支持中文，国人汉化的中文包也停在了9.12.2版本https://github.com/hlmd/postman-cn

Apipost&Apifox：国人做的，支持中文，个人版免费，基本上Postman有的他们都有，还支持协作，支持web版，导出各种文档，生成各种语言的代码。主要是服务器在国内，你的工作空间可以同步到远端，而postman服务器在国外，访问速度很慢，尽量不要注册登录，否则打开会很卡。

3. 数据格式

Elasticsearch 是面向文档型数据库，一条数据在这里就是一个文档。

Elasticsearch 里存储文档数据和关系型数据库 MySQL 存储数据的概念进行一个类比

ES 里的 Index 可以看做一个库，而 Types 相当于表，Documents 则相当于表的行。这里 Types 的概念已经被逐渐弱化，Elasticsearch 6.X 中，一个 index 下已经只能包含一个type，Elasticsearch 7.X 中, Type 的概念已经被删除了。

6 用 JSON 作为文档序列化的格式，比如一条用户信息：

{
  "name" : "John",
  "sex" : "Male",
  "age" : 25,
  "birthDate": "1990/05/01",
  "about" : "I love to go rock climbing",
  "interests": [ "sports", "music" ]
}

4. HTTP操作

4.1 索引操作

创建索引

对比关系型数据库，创建索引就等同于创建数据库

向 ES 服务器发 PUT 请求：http://127.0.0.1:9200/shopping

{
  "acknowledged"【响应结果】: true, # true 操作成功
  "shards_acknowledged"【分片结果】: true, # 分片操作成功
  "index"【索引名称】: "shopping"
}
# 注意：创建索引库的分片数默认 1 片，在 7.0.0 之前的 Elasticsearch 版本中，默认 5 片

如果重复添加索引，会返回错误信息

查看单个索引

GET 请求：http://127.0.0.1:9200/shopping

查看索引向 ES 服务器发送的请求路径和创建索引是一致的。但是 HTTP 方法不一致。这里

可以体会一下 RESTful 的意义，

请求后，服务器响应结果如下：

{
  "shopping"【索引名】: {
    "aliases"【别名】: {},
    "mappings"【映射】: {},
    "settings"【设置】: {
      "index"【设置 - 索引】: {
        "creation_date"【设置 - 索引 - 创建时间】: "1614265373911",
        "number_of_shards"【设置 - 索引 - 主分片数量】: "1",
        "number_of_replicas"【设置 - 索引 - 副分片数量】: "1",
        "uuid"【设置 - 索引 - 唯一标识】:"eI5wemRERTumxGCc1bAk2A",
        "version"【设置 - 索引 - 版本】: {
          "created": "7080099"
        },
        "provided_name"【设置 - 索引 - 名称】: "shopping"
      }
    }
  }
}

查看所有索引

GET 请求：http://127.0.0.1:9200/_cat/indices?v

这里请求路径中的_cat 表示查看的意思，indices 表示索引，所以整体含义就是查看当前 ES服务器中的所有索引，就好像 MySQL 中的 show tables 的感觉，服务器响应结果如下：

表头	含义
health	当前服务器健康状态：
	green(集群完整) yellow(单点正常、集群不完整) red(单点不正常)

status	索引打开、关闭状态
index	索引名
uuid	索引统一编号
pri	主分片数量
rep	副本数量

docs.count	可用文档数量
docs.deleted	文档删除状态（逻辑删除）
store.size	主分片和副分片整体占空间大小
pri.store.size	主分片占空间大小

删除索引

DELETE 请求：http://127.0.0.1:9200/shopping

重新访问索引时，服务器返回响应：索引不存在

4.2 文档操作

创建文档

这里的文档可以类比为关系型数据库中的表数据，添加的数据格式为 JSON 格式。

POST 请求：http://127.0.0.1:9200/shopping/_doc

请求体内容为：（请求体必须要有，否则会返回错误信息）

{
  "title":"小米手机",
  "category":"小米",
  "images":"http://www.gulixueyuan.com/xm.jpg",
  "price":3999.00
}

此处发送请求的方式必须为 POST，不能是 PUT，否则会发生类似405错误：

由于在学习中发现Apipost6.x版本出现了点问题，我切换成5.x版本了。界面上会和上面的截图有所出入。

问题原因是Apipost6.x版本会对响应码201做重定向处理，导致ES服务器收到的是Get请求。错误信息如上图所示。已经反馈给官方，后续版本会进行修复。

国产还需继续努力啊。

正常服务器响应结果如下：

{
  "_index"【索引】: "shopping",
  "_type"【 类型-文档 】: "_doc",
  "_id"【唯一标识】: "w_WoYoIBNKuSN7cz5FHR", #可以类比为 MySQL 中的主键，随机生成
  "_version"【版本】: 1,
  "result"【结果】: "created", #这里的 created 表示创建成功
  "_shards"【分片】: {
    "total"【分片 - 总数】: 2,
    "successful"【分片 - 成功】: 1,
    "failed"【分片 - 失败】: 0
  },
  "_seq_no": 0,
  "_primary_term": 1
}

上面的数据创建后，由于没有指定数据唯一性标识（ID），默认情况下，ES 服务器会随机生成一个。

如果想要自定义唯一性标识，需要在创建时指定:http://127.0.0.1:9200/shopping/_doc/1

此处需要注意：如果增加数据时明确数据主键，那么请求方式也可以为 PUT

查看单个文档

查看文档时，需要指明文档的唯一性标识，类似于 MySQL 中数据的主键查询

GET 请求：http://127.0.0.1:9200/shopping/_doc/1

{
  "_index"【索引】: "shopping",
  "_type"【文档类型】: "_doc",
  "_id": "1",
  "_version": 2,
  "_seq_no": 2,
  "_primary_term": 2,
  "found"【查询结果】: true, # true 表示查找到，false 表示未查找到
  "_source"【文档源信息】: {
    "title": "华为手机",
    "category": "华为",
    "images": "http://www.gulixueyuan.com/hw.jpg",
    "price": 4999.00
  }
}

修改文档（全量修改）

和新增文档一样，输入相同的 URL 地址请求，如果请求体变化，会将原有的数据内容覆盖。

POST/PUT 请求：http://127.0.0.1:9200/shopping/_doc/1

{
  "title":"小米手机",
  "category":"小米",
  "images":"http://www.gulixueyuan.com/xm.jpg",
  "price":2999.00
}

{
  "_index": "shopping",
  "_type": "_doc",
  "_id": "1",
  "_version"【版本】: 2,
  "result"【结果】: "updated", # updated 表示数据被更新
  "_shards": {
    "total": 2,
    "successful": 1,
    "failed": 0
    },
  "_seq_no": 2,
  "_primary_term": 2
}

修改字段（局部修改）

修改数据时，也可以只修改某一给条数据的局部信息

POST 请求：http://127.0.0.1:9200/shopping/_update/1

请求体内容为：

{
  "doc": {
    "price":3000.00
  }
}

根据唯一性标识，查询文档数据，文档数据已经更新

删除文档

删除一个文档不会立即从磁盘上移除，它只是被标记成已删除（逻辑删除）。

DELETE 请求：http://127.0.0.1:9200/shopping/_doc/1

{
  "_index": "shopping",
  "_type": "_doc",
  "_id": "1",
  "_version"【版本】: 4, #对数据的操作，都会更新版本
  "result"【结果】: "deleted", # deleted 表示数据被标记为删除
  "_shards": {
    "total": 2,
    "successful": 1,
    "failed": 0
  },
  "_seq_no": 4,
  "_primary_term": 2
}

删除后再查询当前文档信息

如果删除一个并不存在的文档