ElasticSearch（二）REST APIs

已于 2023-08-09 10:43:10 修改
阅读量159 收藏
点赞数
分类专栏： 数据库 文章标签： elasticsearch 大数据 搜索引擎
于 2023-08-01 13:54:45 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/omolin1/article/details/132038632
版权

elasticsearch提供比较齐全的各种功能点的API，如/_cat，/_xpack等，该文档是基于ElasticSearch8.0版本进行梳理

1、Info API

提供关于x-pack特征信息，负责安全问题使用该功能

http://ip:9200/_xpack 

GET /_xpack?categories=build,features 该请求只会返回build和features
GET /_xpack?human=false 该请求会移除human描述

2、CAT API

提供关于elasticsearch运行状态等信息检查，是比较常见的一种接口

http://ip:9200/_cat，提供了很多中检查接口，可以查看很多基本信息

/_cat/allocation 提供分配给每个数据节点的分片数量及其磁盘空间的快照。
<!--分片信息-->
/_cat/shards
/_cat/shards/{index}
/_cat/master 返回有关主节点的信息，包括ID、绑定IP地址和名称
/_cat/nodes 返回节点信息
/_cat/tasks 返回正在执行的任务信息
<!--返回索引信息-->
/_cat/indices
/_cat/indices/{index}
<!--返回索引分片中Lucene段的低级信息，类似于索引段API-->
/_cat/segments
/_cat/segments/{index}
<!--计数-->
/_cat/count
/_cat/count/{index}
<!--返回正在进行或者已完成的碎片恢复信息-->
/_cat/recovery
/_cat/recovery/{index}
<!--返回群集的运行状况状态，类似于群集运行状况-->
/_cat/health
/_cat/pending_tasks 返回尚未执行的集群级更改，类似于挂起的集群任务API
/_cat/aliases     应用程序消耗
/_cat/aliases/{alias}
<!--返回每个节点的线程池信息-->
/_cat/thread_pool
/_cat/thread_pool/{thread_pools}
/_cat/plugins 返回运行在每个节点上的插件
<!--返回集群中每个数据节点上的字段数据缓存当前使用的堆内存量-->
/_cat/fielddata
/_cat/fielddata/{fields}
/_cat/nodeattrs 返回节点属性信息
/_cat/repositories 返回快照仓库信息
/_cat/snapshots/{repository} 返回快照信息
/_cat/templates 返回索引模板信息
<!-- 返回有关异常检测作业的配置和信息-->
/_cat/ml/anomaly_detectors
/_cat/ml/anomaly_detectors/{job_id}
<!--返回关于推理训练模型的配置和使用信息-->
/_cat/ml/trained_models
/_cat/ml/trained_models/{model_id}
<!--返回关于数据提要的配置和使用信息-->
/_cat/ml/datafeeds
/_cat/ml/datafeeds/{datafeed_id}
<!--返回有关数据帧分析作业的配置和使用信息-->
/_cat/ml/data_frame/analytics
/_cat/ml/data_frame/analytics/{id}
<!--返回有关转换的配置和使用信息-->
/_cat/transforms
/_cat/transforms/{transform_id}

如

   /_cat/master?v=true可以查看主节点的节点信息

/_cat/indices?pretty可以查看索引信息
/_cat/templates?v=true&s=order:desc,index_patterns 实现模板排序

3、Cluster API

介绍集群节点通用API

集群相关

提供分片分配解释信息
GET _cluster/allocation/explain
POST _cluster/allocation/explain

如：

GET _cluster/allocation/explain
{
  "index": "my-index-000001",
  "shard": 0,
  "primary": true
}
提供集群范围设置
GET /_cluster/settings
提供集群健康状态
GET /_cluster/health?wait_for_status=yellow&timeout=50s
提供改变集群分片分配
POST /_cluster/reroute
{
  "commands": [
    {
      "move": {
        "index": "test", "shard": 0,
        "from_node": "node1", "to_node": "node2"
      }
    },
    {
      "allocate_replica": {
        "index": "test", "shard": 1,
        "node": "node3"
      }
    }
  ]
}

返回群集状态的内部表示形式，用于调试或诊断目的

GET /_cluster/state
返回集群统计数据
如：GET /_cluster/stats?human&pretty
严格限制节点
GET /_cluster/stats/nodes/node1,node*,master:false
配置动态集群设置
PUT /_cluster/settings
{
  "persistent" : {
    "indices.recovery.max_bytes_per_sec" : "50mb"
  }
}
PUT /_cluster/settings
{
  "transient" : {
    "indices.recovery.*" : null
  }
}
返回尚未执行的集群级更改

GET /_cluster/pending_tasks

返回配置的远程集群信息

GET /_remote/info

返回集群目前执行的任务

GET /_tasks/<task_id>

GET /_tasks

如：

GET _tasks 
GET _tasks?nodes=nodeId1,nodeId2 
GET _tasks?nodes=nodeId1,nodeId2&actions=cluster:*

从投票配置表里删除或者添加符合主节点资格的节点

POST /_cluster/voting_config_exclusions?node_names=<node_names>

POST /_cluster/voting_config_exclusions?node_ids=<node_ids>

DELETE /_cluster/voting_config_exclusions

如：

POST /_cluster/voting_config_exclusions?node_names=nodeName1,nodeName2
DELETE /_cluster/voting_config_exclusions

节点相关

返回节点使用属性信息

GET /_nodes/usage

GET /_nodes/<node_id>/usage

GET /_nodes/usage/<metric>

GET /_nodes/<node_id>/usage/<metric>

返回集群中每个选定节点的热线程

GET /_nodes/hot_threads

GET /_nodes/<node_id>/hot_threads

返回节点信息

GET /_nodes

GET /_nodes/<node_id>

GET /_nodes/<metric>

GET /_nodes/<node_id>/<metric>

如：

# return just process
GET /_nodes/process

# same as above
GET /_nodes/_all/process

# return just jvm and process of only nodeId1 and nodeId2
GET /_nodes/nodeId1,nodeId2/jvm,process

# same as above
GET /_nodes/nodeId1,nodeId2/info/jvm,process

# return all the information of only nodeId1 and nodeId2
GET /_nodes/nodeId1,nodeId2/_all

# return all the information of plugins 
GET /_nodes/plugins
返回节点安全存储键等信息

POST /_nodes/reload_secure_settings
POST /_nodes/<node_id>/reload_secure_settings

返回节点统计状态

GET /_nodes/stats

GET /_nodes/<node_id>/stats

GET /_nodes/stats/<metric>

GET /_nodes/<node_id>/stats/<metric>

GET /_nodes/stats/<metric>/<index_metric>

GET /_nodes/<node_id>/stats/<metric>/<index_metric>

如：

# return just indices
GET /_nodes/stats/indices

# return just os and process
GET /_nodes/stats/os,process

# return just process for node with IP address 10.0.0.1
GET /_nodes/10.0.0.1/stats/process

4、Cross-cluster 复制API

状态：GET /_ccr/stats

创建复制索引：

PUT /<follower_index>/_ccr/follow?wait_for_active_shards=1
{
  "remote_cluster" : "<remote_cluster>",
  "leader_index" : "<leader_index>"
}

暂停复制索引：

POST /<follower_index>/_ccr/pause_follow

恢复复制索引：

POST /<follower_index>/_ccr/resume_follow
{
}

将复制索引变成常规索引

POST /<follower_index>/_ccr/unfollow

获取索引状态

GET /<index>/_ccr/stats

获取索引信息

GET /<index>/_ccr/info

5、Document API

添加或者更新索引

将JSON文档添加到指定的数据流或索引，并使其可搜索。如果目标是索引并且文档已经存在，则请求更新文档并增加其版本

PUT /<target>/_doc/<_id>

POST /<target>/_doc/

PUT /<target>/_create/<_id>

POST /<target>/_create/<_id>

如：创建文档id自动添加的

POST my-index-000001/_doc/
{
  "@timestamp": "2099-11-15T13:12:00",
  "message": "GET /search HTTP/1.1 200 1070000",
  "user": {
    "id": "kimchy"
  }
}

创建指定id的文档

PUT my-index-000001/_doc/1
{
  "@timestamp": "2099-11-15T13:12:00",
  "message": "GET /search HTTP/1.1 200 1070000",
  "user": {
    "id": "kimchy"
  }
}
PUT my-index-000001/_doc/1?version=2&version_type=external
{
  "user": {
    "id": "elkbee"
  }
}
获取某个索引的文档信息

GET <index>/_doc/<_id>

HEAD <index>/_doc/<_id>

GET <index>/_source/<_id>

HEAD <index>/_source/<_id>

如：

GET my-index-000001/_doc/0
GET my-index-000001/_source/1
HEAD my-index-000001/_source/1
删除某个索引的文档信息

DELETE /<index>/_doc/<_id>

POST /<target>/_delete_by_query  删除查询到条件的文档记录

如：

DELETE /my-index-000001/_doc/1?routing=shard-1
POST /my-index-000001/_delete_by_query
{
  "query": {
    "match": {
      "user.id": "elkbee"
    }
  }
}
POST /my-index-000001,my-index-000002/_delete_by_query
{
  "query": {
    "match_all": {}
  }
}
更新文档信息

POST /<index>/_update/<_id>

POST /<target>/_update_by_query 按条件查询进行更新

通过脚本进行更新，主要在source里进行条件判定

POST test/_update/1
{
  "script" : {
    "source": "ctx._source.counter += params.count",
    "lang": "painless",
    "params" : {
      "count" : 4
    }
  }
}

更新部分

POST test/_update/1
{
  "doc": {
    "name": "new_name"
  }
}

按条件查询进行更新

POST my-index-000001/_update_by_query?conflicts=proceed
{
  "query": { 
    "term": {
      "user.id": "kimchy"
    }
  }
}
检索多个文档
GET /_mget
{
  "docs": [
    {
      "_index": "my-index-000001",
      "_id": "1"
    },
    {
      "_index": "my-index-000001",
      "_id": "2"
    }
  ]
}
复制索引
POST _reindex
{
  "source": {
    "index": "my-index-000001"
  },
  "dest": {
    "index": "my-new-index-000001"
  }
}

6、Enrich 策略API

类似mysql的join方法

PUT /_enrich/policy/<enrich-policy>

DELETE /_enrich/policy/<enrich-policy>

GET /_enrich/policy/<name>

GET /_enrich/policy

GET /_enrich/policy/policy1,policy2

PUT /_enrich/policy/<enrich-policy>/_execute

POST /_enrich/policy/<enrich-policy>/_execute

PUT /_enrich/policy/my-policy
{
  "match": {
    "indices": "users",
    "match_field": "email",
    "enrich_fields": ["first_name", "last_name", "city", "zip", "state"]
  }
}
DELETE /_enrich/policy/my-policy
GET /_enrich/policy/my-policy
GET /_enrich/policy/my-policy,other-policy
PUT /_enrich/policy/my-policy/_execute
GET /_enrich/_stats

7、Index API

索引相关的API集合

检查别名是否存在

HEAD _alias/<alias>

HEAD <target>/_alias/<alias>

添加别名
POST _aliases
{
  "actions": [
    {
      "add": {
        "index": "my-data-stream",
        "alias": "my-alias"
      }
    }
  ]
}
文本分析
GET /_analyze
{
  "analyzer" : "standard",
  "text" : "Quick Brown Foxes!"
}
清除索引缓存
POST /my-index-000001/_cache/clear

如：

POST /my-index-000001/_cache/clear?fielddata=true  
POST /my-index-000001/_cache/clear?query=true      
POST /my-index-000001/_cache/clear?request=true
克隆索引
POST /my-index-000001/_clone/cloned-my-index-000001

POST /<index>/_clone/<target-index>

PUT /<index>/_clone/<target-index>

如：支持setting和aliases参数

POST /my_source_index/_clone/my_target_index
{
  "settings": {
    "index.number_of_shards": 5 
  },
  "aliases": {
    "my_search_indices": {}
  }
}
关闭索引
POST /my-index-000001/_close

响应：

{
  "acknowledged": true,
  "shards_acknowledged": true,
  "indices": {
    "my-index-000001": {
      "closed": true
    }
  }
}
创建索引

PUT /<index>

如：可以设置settings、mappings、aliases等参数

PUT /my-index-000001
{
  "settings": {
    "index": {
      "number_of_shards": 3,  
      "number_of_replicas": 2 
    }
  }
}
PUT /test
{
  "settings": {
    "number_of_shards": 1
  },
  "mappings": {
    "properties": {
      "field1": { "type": "text" }
    }
  }
}
删除别名
DELETE my-data-stream/_alias/my-alias
删除索引
DELETE /my-index-000001
删除索引模板
DELETE /_index_template/my-index-template
检查数据流、索引或者别名是否存在
HEAD my-data-stream
刷新数据流或者索引
POST /my-index-000001/_flush
索引分片融合
POST /my-index-000001/_forcemerge

如：

POST /my-index-000001,my-index-000002/_forcemerge
获取别名
GET my-data-stream/_alias/my-alias
获取属性映射
GET /my-index-000001/_mapping/field/user
获取索引
GET /my-index-000001
获取索引设置
GET /my-index-000001/_settings
获取索引模板
GET /_index_template/template_1

获取所有索引模板

GET /_index_template
获取索引映射
GET /my-index-000001/_mapping
导入悬垂索引
POST /_dangling/<index-uuid>?accept_data_loss=true
索引还原
GET /my-index-000001/_recovery
拆分索引到更多分片
POST /my-index-000001/_split/split-my-index-000001
{
  "settings": {
    "index.number_of_shards": 2
  }
}
更新索引
PUT /my-index-000001/_settings
{
  "index" : {
    "number_of_replicas" : 2
  }
}

注释：

ElasticSearch官网文档提供了很多的RESTful API，比如机器学习API、脚本API、安全API、快照和存储API、SQL API、观测API等，具体详情可以查看官网信息，内容较多，本文只是讲解ElasticSearch基本的一些索引相关接口。

官网：欢迎来到 Elastic — Elasticsearch 和 Kibana 的开发者 | Elastic

一刀小诗
关注
专栏目录
ElasticSearch的REST APIs 之 索引的模板管理
aben_sky的专栏
11-03 957
基于ES 7.7 英文官方文档 主要内容: 新增或修改索引模板(Put index templates) 删除索引模板(Deltet inde...
ElasticSearch的REST APIs 之 索引的mapping管理
aben_sky的专栏
10-21 1297
基于ES 7.7 包括4个api: Put mapping, Get mapping, Get field mapping, Type exists(7....
elasticsearch7.x clusterAPI之voting_config_exclusions
荣耀之路
09-15 1061
voting_config_exclusions
elasticsearch7.x集群API之nodes usage
荣耀之路
09-20 275
nodes usage
Elasticsearch(CCR)主从同步之跨集群复制
jsugs的博客
12-09 2740
注： 部分概念介绍来源于网络 1.跨集群复制Cross-cluster replication (CCR) 跨集群复制最早发布版本Elasticsearch 6.7 版本 跨集群复制 (CCR) 功能支持将特定索引从一个 ElasticSearch 集群复制到一个或多个 ElasticSearch 集群。 复制索引是只读的 索引可以由一个或多个 Elasticsearch 集群进行复制。每个复制索引的集群都维护一份索引的只读副本。能够接受写操作的主动索引称为领导者。索引的被动只读副本称为追随者。并不存在选
Elasticsearch常用查询
NaShiYu的博客
05-24 475
Elasticsearch常用查询
es的节点退役
Automato的博客
02-23 657
es退役节点
ElasticSearch的REST APIs 之 索引的别名(alias)管理
aben_sky的专栏
10-22 1830
基于 ES 7.7, 官方文档 注意: 7.15版本中调整了分类, 把7.7版本中的Add和Update合并为"Create or Update",...
ElasticSearch的REST APIs 之 索引的监控(monitoring)
aben_sky的专栏
11-04 1174
基于ES7.7 官方文档 内容包括: 索引的统计信息 (Index stats) 索引的段 (Index segments) 索引的恢复信...
【ES】Elasticsearch Java Rest Client （Document APIs）官方文档中文翻译
qq_44667083的博客
04-18 1963
这里写目录标题一、文档APIs1.单文档 APIIndex APIGet APIGet Source APIExists APIDelete APIUpdate APITerm Vectors API2.多文档 APIBulk APIMulti-Get APIReindex APIUpdate By Query APIDelete By Query APIRethrottle APIMulti Term Vectors API 官网连接 一、文档APIs Java 高级 REST 客户端支持以下文档 A
ES 7.6.2集群迁移（从一套ES集群迁移数据到另一套集群）
雅冰石的专栏
10-27 3017
有时有需要从ES集群中去除多个节点的需求，比如迁移一套ES集群到另外一套ES集群，这时可以先将新的ES节点加入到现有集群里，再将老ES节点下线。 一 实验环境 ​​​​​二 实验步骤 2.1 集群扩容-添加新节点 可参考ES集群扩容-新增一个节点_雅冰石的专栏-CSDN博客 该文章以新增一个节点node-4为例，请参考该文章为ES集群新增三个节点，令外两个节点名称分别是node-5及node-6. 2.2 集群缩容-去除老节点 删除符合主节点条件的节点时，不要同时删除太多的节点，这一.
Elasticsearch：使用 Elastic 有监督的机器学习进行二进制分类
Elastic 中国社区官方博客
08-04 2995
Elastic Stack 7.6 版本提供了端到端机器学习管道所需的最后一部分。 以前，机器学习专注于具有异常检测功能的无监督技术。 但是，在7.x发行版中已经发布了一些功能。 在 7.2 中，Elasticsearch 发布了用于将原始索引转换为特征索引的 transforms。 然后7.3、7.4和7.5分别发布了异常值检测（outlier detection），回归（regression）和分类（classification）。 最后，在7.6中，你可以将回归和分类模型与推理提取处理器一起使用，以丰
Elasticsearch：ES|QL 快速入门
Elastic 中国社区官方博客
11-14 439
目前的最新发型办为 Elastic Stack 8.11。Elasticsearch 查询语言 (ES|QL) 提供了一种强大的方法来过滤、转换和分析存储在 Elasticsearch 中以及未来其他运行时中的数据。它旨在易于最终用户、SRE 团队、应用程序开发人员和管理员学习和使用。
Elasticsearch：如何使用 Elasticsearch ingest 节点来丰富日志和指标
Elastic 中国社区官方博客
05-13 2242
当导入数据到Elasticsearch中时，用其他信息丰富文档通常是有益的，这些信息以后可用于搜索或查看数据。丰富化是将权威来源的数据合并到文档中的过程，这些数据被摄入到Elasticsearch中。 例如，可以使用GeoIP处理器来进行扩充，该处理器可以处理包含IP地址的文档，并添加有关与每个IP地址关联的地理位置的信息。在导入数据时用地理位置丰富文档非常有用，因为它允许快速的查询时操作，例如按位置查询或在地图上高效地显示信息。 虽然GeoIP处理器是了解丰富功能的一个很好的例子，但在许多其他情况下，
Elasticsearch 利用 Enrich Processor 实现 MYSQL Join 的操作，支持Nested类型，具体应用。
alexgaoyihang的专栏
04-08 381
在关系型数据库中，表关联是非常常见的操作，放到 Elasticsearch 的场景，相当于跨索引进行数据关联，本文使用 Enrich Processor，在数据预处理阶段把数据进行维护，最终使得数据在存储的时候，就是已经进行过数据关联的。举一个很常见的 省市区行政区域扩充的例子(同理类似于 字典 处理的场景)，在保存数据的时候，把关联的数据查询出来并存到 document 中。初始化假设初始化一个索引： dict-detail，索引中包含的数据值如下所示，都是 keyword 类型，数据值如下所示。
ElasticSearch集群
最新发布
baidu_32223873的博客
07-06 710
服务发现的触发时机：1、启动一个新节点。2、当一个节点认为主节点宕机节点启动时，会根据discovery.seed_hosts的配置+数据目录中保存的集群元数据来发现集群其他节点，向这些节点发送消息，这些节点收到后将自己是否是候选者、自己知道的候选者回复给发送者，如果没有主节点并且已发现足够多的候选者，则开始投票选主。
02.es的节点发现和集群构建
寒夜
10-26 1142
文章目录1. 简介2. 节点发现3. 多数生效的操作4. 投票人信息设置1. Voting configurations 中的节点信息2. Voting configurations 为何只保留奇数的master-eligible node3. cluster进行增减master-eligible node 的时候Voting configurations 的变化1. Voting configurations 的管理策略2. 增加master-eligible node3. 移除master-eligib
在es集群中添加和删除节点
HHFQ的博客
09-21 4067
当启动 Elasticsearch 实例时，正在启动一个节点。 Elasticsearch 集群是一组具有相同 cluster.name 属性的节点。 当节点加入或离开集群时，集群会自动重新组织自身以在可用节点之间均匀分布数据。 如果正在运行 Elasticsearch 的单个实例，则拥有一个包含一个节点的集群。 所有主分片都驻留在单个节点上。 无法分配副本分片，因此集群状态保持为黄色。 集群功能齐全，但在发生故障时有数据丢失的风险。 可以向集群添加节点以提高其容量和可靠性。 默认情况下，一个节点既是数据
elasticsearch Discovery 发现模块学习
独行侠梦的博客
09-22 1272
发现模块和集群的形成 目标 发现节点 Master选举 组成集群，在Master信息发生变化时及时更新。 故障检测 细分为几个子模块 Discovery发现模块 Discover是在集群Master节点未知时，互相发现对方的过程，例如新节点的加入或是先前的主节点宕机，如果一个节点不满足Master资格，则它将继续发现，直到发现了选定的主节点为止，其中，重试配置的属性为：discover...
Elasticsearch REST客户端6.3.0中文API文档大全
资源摘要信息: "elasticsearch-rest-client-6.3.0-API文档-中文版.zip" 文件包含了与 Elasticsearch 相关的 REST 客户端库的多个组件和文档，适用于需要与 Elasticsearch 进行交互的 Java 开发者。以下是详细的知识...
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值