Elasticsearch中文文档——基于v7.11

翻译目标及说明

基于官方 v7.11 文档，翻译为中文，并发布在网站查看。

由于官方版本更新比较快，文档虽然是基于 v7.11 开始翻译，但实际翻译过程中，后续的文档都是翻译时当时的最新版本。

计划在全部翻译完成后，再基于完成时的最新版本，对有差异的老版本文档进行调整。

由于文档过于庞大，不会按照文档先后顺序进行翻译。将优先进行 API 文档、相关使用的翻译，然后是基本配置等，最后再是基础概念、进阶等。

翻译过程中，随着对相应概念的学习与理解，可能存在不同文档中对同一名词翻译时选词不同；或者对不同文档中的相同英文描述，翻译时有不同的中文表述（如一个使用子句，一个使用长句）。这些问题在翻译过程中在所难免，如果大家有发现，欢迎指出，我会将其修改一致。

对某些翻译有疑义或者读起来不符合中文用词、造句，也请大家按照“信达雅”的标准提出 Issue 指正，让我们大家一起将其完善。

希望在大家的努力下，一起翻译出一份符合中文习惯，且阅读起来令人舒适的文档。这样的好文档才能帮助学习人的进步。这也是我翻译想达到的最高目标。

查看文档

在网站查看文档

感谢与支持

如果对你有帮助，欢迎给我一颗星。

但你的赞赏比感谢更有力！

要不请我喝咖啡吧，谢谢。

本地运行

本文档基于 VuePress 编译后发布。本地通过 npm 安装 VuePress 工具后，即可本地运行。

1. 进入项目目录
2. 执行 npm run docs:dev

cd /elasticsearch-doc
npm run docs:dev

控制台显示如下示例后，即可通过浏览器输入 URL 地址查看文档：

success [16:17:40] Build 9a5052 finished in 14671 ms!
> VuePress dev server listening at http://localhost:8080/

文档列表及进度

已完成的部分标示 ✔️，并添加网站链接。

• ✔️ 什么是 Elasticsearch？ 🔗
  • ✔️ 数据输入：文档和索引 🔗
  • ✔️ 信息输出：搜索和分析 🔗
  • ✔️ 可伸缩性和弹性 🔗
• ✔️ Elasticsearch 入门 🔗
  • ✔️ 启动并运行 Elasticsearch 🔗
  • ✔️ 索引一些文档 🔗
  • ✔️ 开始搜索 🔗
  • ✔️ 使用聚合分析结果 🔗
  • ✔️ 何去何从 🔗
• ✔️ 设置 Elasticsearch 🔗
  • ✔️ 安装 Elasticsearch 🔗
    • ✔️ Linux 或 MacOS 上用存档安装 Elasticsearch 🔗
    • ✔️ 在 Windows 上用 .zip 安装 Elasticsearch 🔗
    • ✔️ 使用 Debian 包安装 Elasticsearch 🔗
    • ✔️ 使用 RPM 安装 Elasticsearch 🔗
    • ✔️ 使用 Windows MSI 安装程序安装 Elasticsearch 🔗
    • ✔️ 使用 Docker 安装 Elasticsearch 🔗
    • ✔️ 使用 Homebrew 在 macOS 上安装 Elasticsearch 🔗
  • ✔️ 配置 Elasticsearch 🔗
    • ✔️ 重要的 Elasticsearch 配置 🔗
    • ✔️ 安全配置 🔗
    • ✔️ 审计安全设置 🔗
    • ✔️ 断路器设置 🔗
    • ✔️ 集群级分片分配和路由设置 🔗
    • ✔️ 跨集群复制设置 🔗
    • ✔️ 发现和集群组成设置 🔗
    • ✔️ 字段数据缓存设置 🔗
    • ✔️ Elasticsearch 中的健康诊断设置 🔗
    • ✔️ 索引生命周期管理设置 🔗
    • ✔️ 索引管理设置 🔗
    • ✔️ 索引恢复设置 🔗
    • ✔️ 索引缓冲区设置 🔗
    • License settings
    • Local gateway settings
    • Logging
    • Machine learning settings
    • Monitoring settings
    • Node
    • Network settings
    • Node query cache settings
    • Search settings
    • Security settings
    • Shard request cache settings
    • Snapshot lifecycle management settings
    • Transforms settings
    • Transport
    • Thread pools
    • Watcher settings
    • Advanced configuration settings
  • Important Elasticsearch configuration
  • Important System Configuration
    • Configuring system settings
    • Disable swapping
    • File Descriptors
    • Virtual memory
    • Number of threads
    • DNS cache settings
    • JNA temporary directory not mounted with noexec
    • TCP retransmission timeout
  • Bootstrap Checks
    • Heap size check
    • File descriptor check
    • Memory lock check
    • Maximum number of threads check
    • Max file size check
    • Maximum size virtual memory check
    • Maximum map count check
    • Client JVM check
    • Use serial collector check
    • System call filter check
    • OnError and OnOutOfMemoryError checks
    • Early-access check
    • G1GC check
    • All permission check
    • Discovery configuration check
  • Bootstrap Checks for X-Pack
  • Starting Elasticsearch
  • Stopping Elasticsearch
  • Discovery and cluster formation
    • Discovery
    • Quorum-based decision making
    • Voting configurations
    • Bootstrapping a cluster
    • Publishing the cluster state
    • Cluster fault detection
  • Add and remove nodes in your cluster
  • Full-cluster restart and rolling restart
  • Remote clusters
  • Set up X-Pack
  • Configuring X-Pack Java Clients
  • Plugins
• Upgrade Elasticsearch
  • Rolling upgrades
  • Full cluster restart upgrade
  • Reindex before upgrading
    • Reindex in place
    • Reindex from a remote cluster
• ✔️ 索引模块 🔗
  • ✔️ 分析 🔗
  • ✔️ 索引分片分配 🔗
    • ✔️ 索引级分片分配过滤 🔗
    • ✔️ 当节点离开时延迟分配 🔗
    • ✔️ 索引恢复优先级 🔗
    • ✔️ 每节点分片总数 🔗
    • ✔️ 索引级数据层分配过滤 🔗
  • ✔️ 索引块 🔗
  • ✔️ 映射器 🔗
  • Merge
  • Similarity module
  • Slow Log
  • Store
    • Preloading data into the file system cache
  • Translog
  • History retention
  • Index Sorting
    • Use index sorting to speed up conjunctions
  • Indexing pressure
• Mapping
  • Dynamic mapping
    • Dynamic field mapping
    • Dynamic templates
  • Explicit mapping
  • Runtime fields
    • Map a runtime field
    • Define runtime fields in a search request
    • Override field values at query time
    • Retrieve a runtime field
    • Explore your data with runtime fields
  • Field data types
    • Aggregate metric
    • Alias
    • Arrays
    • Binary
    • Boolean
    • Date
    • Date nanoseconds
    • Dense vector
    • Flattened
    • Geo-point
    • Geo-shape
    • Histogram
    • IP
    • Join
    • Keyword
    • Nested
    • Numeric
    • Object
    • Percolator
    • Point
    • Range
    • Rank feature
    • Rank features
    • Search-as-you-type
    • Shape
    • Sparse vector
    • Text
    • Token count
    • Unsigned long
    • Version
  • Metadata fields
    • _doc_count field
    • _field_names field
    • _ignored field
    • _id field
    • _index field
    • _meta field
    • _routing field
    • _source field
    • _type field
  • Mapping parameters
    • analyzer
    • boost
    • coerce
    • copy_to
    • doc_values
    • dynamic
    • eager_global_ordinals
    • enabled
    • format
    • ignore_above
    • ignore_malformed
    • index
    • index_options
    • index_phrases
    • index_prefixes
    • meta
    • fields
    • normalizer
    • norms
    • null_value
    • position_increment_gap
    • properties
    • search_analyzer
    • similarity
    • store
    • term_vector
  • Mapping limit settings
  • Removal of mapping types
• Text analysis
  • Overview
  • Concepts
    • Anatomy of an analyzer
    • Index and search analysis
    • Stemming
    • Token graphs
  • Configure text analysis
    • Test an analyzer
    • Configuring built-in analyzers
    • Create a custom analyzer
    • Specify an analyzer
  • Built-in analyzer reference
    • Fingerprint
    • Keyword
    • Language
    • Pattern
    • Simple
    • Standard
    • Stop
    • Whitespace
  • Tokenizer reference
    • Character group
    • Classic
    • Edge n-gram
    • Keyword
    • Letter
    • Lowercase
    • N-gram
    • Path hierarchy
    • Pattern
    • Simple pattern
    • Simple pattern split
    • Standard
    • Thai
    • UAX URL email
    • Whitespace
  • Token filter reference
    • Apostrophe
    • ASCII folding
    • CJK bigram
    • CJK width
    • Classic
    • Common grams
    • Conditional
    • Decimal digit
    • Delimited payload
    • Dictionary decompounder
    • Edge n-gram
    • Elision
    • Fingerprint
    • Flatten graph
    • Hunspell
    • Hyphenation decompounder
    • Keep types
    • Keep words
    • Keyword marker
    • Keyword repeat
    • KStem
    • Length
    • Limit token count
    • Lowercase
    • MinHash
    • Multiplexer
    • N-gram
    • Normalization
    • Pattern capture
    • Pattern replace
    • Phonetic
    • Porter stem
    • Predicate script
    • Remove duplicates
    • Reverse
    • Shingle
    • Snowball
    • Stemmer
    • Stemmer override
    • Stop
    • Synonym
    • Synonym graph
    • Trim
    • Truncate
    • Unique
    • Uppercase
    • Word delimiter
    • Word delimiter graph
  • Character filters reference
    • HTML strip
    • Mapping
    • Pattern replace
  • Normalizers
• Index templates
  • Simulate multi-component templates
• Data streams
  • Set up a data stream
  • Use a data stream
  • Change mappings and settings for a data stream
• Ingest node
  • Pipeline Definition
  • Accessing Data in Pipelines
  • Conditional Execution in Pipelines
    • Handling Nested Fields in Conditionals
    • Complex Conditionals
    • Conditionals with the Pipeline Processor
    • Conditionals with the Regular Expressions
  • Handling Failures in Pipelines
  • Enrich your data
    • Set up an enrich processor
    • Enrich policy definition
    • Example: Enrich your data based on geolocation
    • Example: Enrich your data based on exact values
  • Processors
    • Append
    • Bytes
    • Circle
    • Convert
    • CSV
    • Date
    • Date index name
    • Dissect
    • Dot expander
    • Drop
    • Enrich
    • Fail
    • Foreach
    • GeoIP
    • Grok
    • Gsub
    • HTML strip
    • Inference
    • Join
    • JSON
    • KV
    • Lowercase
    • Pipeline
    • Remove
    • Rename
    • Script
    • Set
    • Set security user
    • Sort
    • Split
    • Trim
    • Uppercase
    • URL decode
    • User agent
• Search your data
  • Collapse search results
  • Filter search results
  • Highlighting
  • Long-running searches
  • Near real-time search
  • Paginate search results
  • Retrieve inner hits
  • Retrieve selected fields
  • Search across clusters
  • Search multiple data streams and indices
  • Search shard routing
  • Sort search results
• Query DSL
  • Query and filter context
  • Compound queries
    • Boolean
    • Boosting
    • Constant score
    • Disjunction max
    • Function score
  • Full text queries
    • Intervals
    • Match
    • Match boolean prefix
    • Match phrase
    • Match phrase prefix
    • Multi-match
    • Common Terms Query
    • Query string
    • Simple query string
  • Geo queries
    • Geo-bounding box
    • Geo-distance
    • Geo-polygon
    • Geo-shape
  • Shape queries
    • Shape
  • Joining queries
    • Nested
    • Has child
    • Has parent
    • Parent ID
  • Match all
  • Span queries
    • Span containing
    • Span field masking
    • Span first
    • Span multi-term
    • Span near
    • Span not
    • Span or
    • Span term
    • Span within
  • Specialized queries
    • Distance feature
    • More like this
    • Percolate
    • Rank feature
    • Script
    • Script score
    • Wrapper
    • Pinned Query
  • Term-level queries
    • Exists
    • Fuzzy
    • IDs
    • Prefix
    • Range
    • Regexp
    • Term
    • Terms
    • Terms set
    • Type Query
    • Wildcard
  • minimum_should_match parameter
  • rewrite parameter
  • Regular expression syntax
• Aggregations
  • Bucket aggregations
    • Adjacency matrix
    • Auto-interval date histogram
    • Children
    • Composite
    • Date histogram
    • Date range
    • Diversified sampler
    • Filter
    • Filters
    • Geo-distance
    • Geohash grid
    • Geotile grid
    • Global
    • Histogram
    • IP range
    • Missing
    • Nested
    • Parent
    • Range
    • Rare terms
    • Reverse nested
    • Sampler
    • Significant terms
    • Significant text
    • Terms
    • Variable width histogram
    • Subtleties of bucketing range fields
  • Metrics aggregations
    • Avg
    • Boxplot
    • Cardinality
    • Extended stats
    • Geo-bounds
    • Geo-centroid
    • Geo-Line
    • Matrix stats
    • Max
    • Median absolute deviation
    • Min
    • Percentile ranks
    • Percentiles
    • Rate
    • Scripted metric
    • Stats
    • String stats
    • Sum
    • T-test
    • Top hits
    • Top metrics
    • Value count
    • Weighted avg
  • Pipeline aggregations
    • Avg bucket
    • Bucket script
    • Bucket selector
    • Bucket sort
    • Cumulative cardinality
    • Cumulative sum
    • Derivative
    • Extended stats bucket
    • Inference bucket
    • Max bucket
    • Min bucket
    • Moving average
    • Moving function
    • Moving percentiles
    • Normalize
    • Percentiles bucket
    • Serial differencing
    • Stats bucket
    • Sum bucket
• EQL
  • Syntax reference
  • Function reference
  • Pipe reference
  • Example: Detect threats with EQL
• SQL access
  • Overview
  • Getting Started with SQL
  • Conventions and Terminology
    • Mapping concepts across SQL and Elasticsearch
  • Security
  • SQL REST API
    • Overview
    • Response Data Formats
    • Paginating through a large response
    • Filtering using Elasticsearch Query DSL
    • Columnar results
    • Passing parameters to a query
    • Supported REST parameters
  • SQL Translate API
  • SQL CLI
  • SQL JDBC
    • API usage
  • SQL ODBC
    • Driver installation
    • Configuration
  • SQL Client Applications
    • DBeaver
    • DbVisualizer
    • Microsoft Excel
    • Microsoft Power BI Desktop
    • Microsoft PowerShell
    • MicroStrategy Desktop
    • Qlik Sense Desktop
    • SQuirreL SQL
    • SQL Workbench/J
    • Tableau Desktop
  • SQL Language
    • Lexical Structure
    • SQL Commands
    • DESCRIBE TABLE
    • SELECT
    • SHOW COLUMNS
    • SHOW FUNCTIONS
    • SHOW TABLES
    • Data Types
    • Index patterns
    • Frozen Indices
  • Functions and Operators
    • Comparison Operators
    • Logical Operators
    • Math Operators
    • Cast Operators
    • LIKE and RLIKE Operators
    • Aggregate Functions
    • Grouping Functions
    • Date/Time and Interval Functions and Operators
    • Full-Text Search Functions
    • Mathematical Functions
    • String Functions
    • Type Conversion Functions
    • Geo Functions
    • Conditional Functions And Expressions
    • System Functions
  • Reserved keywords
  • SQL Limitations
• Scripting
  • How to use scripts
    • Scripts and search speed
  • Accessing document fields and special variables
  • Scripting and security
  • Painless scripting language
  • Lucene expressions language
  • Advanced scripts using script engines
• Data management
  • Data tiers
  • Index management
• ILM: Manage the index lifecycle
  • Overview
  • Concepts
    • Index lifecycle
    • Rollover
    • Policy updates
  • Automate rollover
  • Customize built-in ILM policies
  • Index lifecycle actions
    • Allocate
    • Delete
    • Force merge
    • Freeze
    • Migrate
    • Read only
    • Rollover
    • Searchable snapshot
    • Set priority
    • Shrink
    • Unfollow
    • Wait for snapshot
  • Configure a lifecycle policy
  • Resolve lifecycle policy execution errors
  • Start and stop index lifecycle management
  • Manage existing indices
  • Skip rollover
  • Restore a managed data stream or index
• Autoscaling
  • Autoscaling deciders
    • Reactive storage decider
    • Proactive storage decider
    • Machine learning decider
    • Fixed decider
• Monitor a cluster
  • Overview
  • How it works
  • Monitoring in a production environment
  • Collecting monitoring data with Metricbeat
  • Collecting log data with Filebeat
  • Configuring indices for monitoring
  • Legacy collection methods
    • Collectors
    • Exporters
    • Local exporters
    • HTTP exporters
    • Pausing data collection
  • Troubleshooting
• Frozen indices
  • Best practices
  • Searching a frozen index
  • Monitoring frozen indices
• Roll up or transform your data
  • Rolling up historical data
    • Overview
    • API quick reference
    • Getting started
    • Understanding groups
    • Rollup aggregation limitations
    • Rollup search limitations
  • Transforming data
    • Overview
    • Setup
    • When to use transforms
    • Transforms at scale
    • How checkpoints work
    • API quick reference
    • Tutorial: Transforming the eCommerce sample data
    • Examples
    • Painless examples
    • Troubleshooting
    • Limitations
• Set up a cluster for high availability
  • Designing for resilience
    • Resilience in small clusters
    • Resilience in larger clusters
  • Back up a cluster
    • Back up the data
    • Back up the cluster configuration
    • Back up the security configuration
    • Restore the security configuration
    • Restore the data
  • Cross-cluster replication
    • Set up cross-cluster replication
    • Manage cross-cluster replication
    • Manage auto-follow patterns
    • Upgrading clusters
• Snapshot and restore
  • Register repository
  • Create a snapshot
  • Restore a snapshot
  • Monitor snapshot and restore
  • Delete a snapshot
  • SLM: Manage the snapshot lifecycle
    • Tutorial: Automate backups with SLM
    • Security and SLM
    • Snapshot retention
  • Searchable snapshots
• Secure a cluster
  • Overview
  • Configuring security
  • User authentication
  • Configuring SAML single-sign-on on the Elastic Stack
  • Configuring single sign-on to the Elastic Stack using OpenID Connect
  • User authorization
  • Enabling audit logging
  • Encrypting communications
  • Restricting connections with IP filtering
  • Cross cluster search, clients, and integrations
  • Tutorial: Getting started with security
  • Tutorial: Encrypting communications
  • Troubleshooting
  • Limitations
• Watch for cluster and index events
  • Getting started with Watcher
  • How Watcher works
  • Encrypting sensitive data in Watcher
  • Inputs
    • Simple input
    • Search input
    • HTTP input
    • Chain input
  • Triggers
    • Schedule trigger
  • Conditions
    • Always condition
    • Never condition
    • Compare condition
    • Array compare condition
    • Script condition
  • Actions
    • Running an action for each element in an array
    • Adding conditions to actions
    • Email action
    • Webhook action
    • Index action
    • Logging action
    • Slack action
    • PagerDuty action
    • Jira action
  • Transforms
    • Search payload transform
    • Script payload transform
    • Chain payload transform
  • Java API
  • Managing watches
  • Example watches
    • Watching the status of an Elasticsearch cluster
    • Watching event data
  • Troubleshooting
  • Limitations
• Command line tools
  • elasticsearch-certgen
  • elasticsearch-certutil
  • elasticsearch-croneval
  • elasticsearch-keystore
  • elasticsearch-migrate
  • elasticsearch-node
  • elasticsearch-saml-metadata
  • elasticsearch-setup-passwords
  • elasticsearch-shard
  • elasticsearch-syskeygen
  • elasticsearch-users
• How To
  • General recommendations
  • Recipes
  • Tune for indexing speed
  • Tune for search speed
  • Tune for disk usage
  • Size your shards
• Glossary of terms
• ✔️ REST API 🔗
  • ✔️ API 约定 🔗
    • ✔️ 多目标语法 🔗
    • ✔️ 索引名中的日期数学支持 🔗
    • ✔️ Cron 表达式 🔗
    • ✔️ 常用选项 🔗
    • ✔️ 基于 URL 的访问控制 🔗
  • Autoscaling APIs
    • ✔️ 创建或更新自动伸缩策略 🔗
    • ✔️ 获取自动伸缩策略 🔗
    • ✔️ 删除自动伸缩策略 🔗
    • Get autoscaling policy
  • Compact and aligned text (CAT) APIs
    • cat aliases
    • cat allocation
    • cat anomaly detectors
    • cat count
    • cat data frame analytics
    • cat datafeeds
    • cat fielddata
    • cat health
    • cat indices
    • cat master
    • cat nodeattrs
    • cat nodes
    • cat pending tasks
    • cat plugins
    • cat recovery
    • cat repositories
    • cat segments
    • cat shards
    • cat snapshots
    • cat task management
    • cat templates
    • cat thread pool
    • cat trained model
    • cat transforms
  • Cluster APIs
    • Cluster allocation explain
    • Cluster get settings
    • Cluster health
    • Cluster reroute
    • Cluster state
    • Cluster stats
    • Cluster update settings
    • Nodes feature usage
    • Nodes hot threads
    • Nodes info
    • Nodes reload secure settings
    • Nodes stats
    • Pending cluster tasks
    • Remote cluster info
    • Task management
    • Voting configuration exclusions
  • Cross-cluster replication APIs
    • Get CCR stats
    • Create follower
    • Pause follower
    • Resume follower
    • Unfollow
    • Forget follower
    • Get follower stats
    • Get follower info
    • Create auto-follow pattern
    • Delete auto-follow pattern
    • Get auto-follow pattern
    • Pause auto-follow pattern
    • Resume auto-follow pattern
  • Data stream APIs
    • Create data stream
    • Delete data stream
    • Get data stream
    • Migrate to data stream
    • Data stream stats
    • Promote data stream
  • ✔️ 文档 API 🔗
    • Reading and Writing documents
    • ✔️ 索引 API 🔗
    • Get
    • Delete
    • Delete by query
    • Update
    • Update by query
    • Multi get
    • Bulk
    • Reindex
    • Term vectors
    • Multi term vectors
    • ?refresh
    • Optimistic concurrency control
  • Enrich APIs
    • Put enrich policy
    • Delete enrich policy
    • Get enrich policy
    • Execute enrich policy
    • Enrich stats
  • Graph explore API
  • ✔️ 索引相关 API 🔗
    • ✔️ 别名存在 🔗
    • ✔️ 别名 🔗
    • ✔️ 分析 🔗
    • ✔️ 分析索引磁盘的使用 🔗
    • ✔️ 清除缓存 🔗
    • ✔️ 复制索引 🔗
    • ✔️ 关闭索引 🔗
    • ✔️ 创建索引 🔗
    • ✔️ 创建或更新索引别名 🔗
    • ✔️ 创建或更新组件模板 🔗
    • ✔️ 创建或更新索引模板 🔗
    • Create or update index template (legacy)
    • ✔️ 删除组件模板 🔗
    • ✔️ 删除悬空索引 🔗
    • ✔️ 删除索引 🔗
    • ✔️ 删除索引别名 🔗
    • ✔️ 删除索引模板 🔗
    • Delete index template (legacy)
    • ✔️ 索引存在 🔗
    • Field usage stats
    • ✔️ 冲刷 🔗
    • ✔️ 强制合并 🔗
    • ✔️ 冻结索引 🔗
    • ✔️ 获取索引别名 🔗
    • ✔️ 获取组件模板 🔗
    • ✔️ 获取字段映射 🔗
    • ✔️ 获取索引 🔗
    • ✔️ 获取索引设置 🔗
    • ✔️ 获取索引模板 🔗
    • Get index template (legacy)
    • ✔️ 获取映射 🔗
    • ✔️ 导入悬空索引 🔗
    • Index alias exists
    • ✔️ 索引恢复 🔗
    • ✔️ 索引段 🔗
    • ✔️ 索引分片存储 🔗
    • ✔️ 索引统计 🔗
    • Index template exists (legacy)
    • ✔️ 列出悬空索引 🔗
    • ✔️ 开启索引 🔗
    • heavy_check_mark: 刷新 🔗
    • ✔️ 解析索引 🔗
    • ✔️ 翻转索引 🔗
    • ✔️ 收缩索引 🔗
    • ✔️ 模拟索引 🔗
    • ✔️ 模拟模板 🔗
    • ✔️ 拆分索引 🔗
    • ✔️ 同步冲刷 🔗
    • ✔️ 类型存在 🔗
    • ✔️ 解冻索引 🔗
    • ✔️ 更新索引设置 🔗
    • ✔️ 更新映射 🔗
  • Index lifecycle management APIs
    • Create policy
    • Get policy
    • Delete policy
    • Move to step
    • Remove policy
    • Retry policy
    • Get index lifecycle management status
    • Explain lifecycle
    • Start index lifecycle management
    • Stop index lifecycle management
  • Ingest APIs
    • Put pipeline
    • Get pipeline
    • Delete pipeline
    • Simulate pipeline
  • Info API
  • Licensing APIs
    • Delete license
    • Get license
    • Get trial status
    • Start trial
    • Get basic status
    • Start basic
    • Update license
  • Machine learning anomaly detection APIs
    • Add events to calendar
    • Add jobs to calendar
    • Close jobs
    • Create jobs
    • Create calendars
    • Create datafeeds
    • Create filters
    • Delete calendars
    • Delete datafeeds
    • Delete events from calendar
    • Delete filters
    • Delete forecasts
    • Delete jobs
    • Delete jobs from calendar
    • Delete model snapshots
    • Delete expired data
    • Estimate model memory
    • Find file structure
    • Flush jobs
    • Forecast jobs
    • Get buckets
    • Get calendars
    • Get categories
    • Get datafeeds
    • Get datafeed statistics
    • Get influencers
    • Get jobs
    • Get job statistics
    • Get machine learning info
    • Get model snapshots
    • Get overall buckets
    • Get scheduled events
    • Get filters
    • Get records
    • Open jobs
    • Post data to jobs
    • Preview datafeeds
    • Revert model snapshots
    • Set upgrade mode
    • Start datafeeds
    • Stop datafeeds
    • Update datafeeds
    • Update filters
    • Update jobs
    • Update model snapshots
    • Upgrade model snapshots
  • Machine learning data frame analytics APIs
    • Create data frame analytics jobs
    • Create trained models
    • Update data frame analytics jobs
    • Delete data frame analytics jobs
    • Delete trained models
    • Evaluate data frame analytics
    • Explain data frame analytics
    • Get data frame analytics jobs
    • Get data frame analytics jobs stats
    • Get trained models
    • Get trained models stats
    • Start data frame analytics jobs
    • Stop data frame analytics jobs
  • Migration APIs
    • Deprecation info
  • Reload search analyzers API
  • Repositories metering APIs
    • Get repositories metering information
    • Clear repositories metering archive
  • Rollup APIs
    • Create rollup jobs
    • Delete rollup jobs
    • Get job
    • Get rollup caps
    • Get rollup index caps
    • Rollup search
    • Start rollup jobs
    • Stop rollup jobs
  • ✔️ 搜索相关 API 🔗
    • ✔️ 搜索 🔗
    • ✔️ 异步搜索 🔗
    • ✔️ 时间点 🔗
    • ✔️ kNN 搜索 🔗
    • ✔️ 滚动 🔗
    • ✔️ 清除滚动 🔗
    • ✔️ 搜索模板 🔗
    • ✔️ 多搜索模板 🔗
    • ✔️ 渲染搜索模板 🔗
    • ✔️ 搜索分片 🔗
    • ✔️ 建议器 🔗
    • ✔️ 多重搜索 🔗
    • EQL search
    • Get async EQL search
    • Delete async EQL search
    • Count
    • ✔️ 验证 🔗
    • ✔️ 词语枚举 🔗
    • ✔️ 搜索 🔗
    • ✔️ 分析 🔗
    • ✔️ 字段能力 🔗
    • ✔️ 排序评估 🔗
    • ✔️ 矢量块搜索 🔗
  • Searchable snapshots APIs
    • Mount snapshot
  • Security APIs
    • Authenticate
    • Change passwords
    • Clear cache
    • Clear roles cache
    • Clear privileges cache
    • Clear API key cache
    • Create API keys
    • Create or update application privileges
    • Create or update role mappings
    • Create or update roles
    • Create or update users
    • Delegate PKI authentication
    • Delete application privileges
    • Delete role mappings
    • Delete roles
    • Delete users
    • Disable users
    • Enable users
    • Get API key information
    • Get application privileges
    • Get builtin privileges
    • Get role mappings
    • Get roles
    • Get token
    • Get users
    • Grant API keys
    • Has privileges
    • Invalidate API key
    • Invalidate token
    • OpenID Connect prepare authentication
    • OpenID Connect authenticate
    • OpenID Connect logout
    • SAML prepare authentication
    • SAML authenticate
    • SAML logout
    • SAML invalidate
    • SAML service provider metadata
    • SSL certificate
  • Snapshot and restore APIs
    • Put snapshot repository
    • Verify snapshot repository
    • Get snapshot repository
    • Delete snapshot repository
    • Clean up snapshot repository
    • Clone snapshot
    • Create snapshot
    • Get snapshot
    • Get snapshot status
    • Restore snapshot
    • Delete snapshot
  • Snapshot lifecycle management APIs
    • Put policy
    • Get policy
    • Delete policy
    • Execute snapshot lifecycle policy
    • Execute snapshot retention policy
    • Get snapshot lifecycle management status
    • Get snapshot lifecycle stats
    • Start snapshot lifecycle management
    • Stop snapshot lifecycle management
  • Transform APIs
    • Create transform
    • Delete transform
    • Get transforms
    • Get transform statistics
    • Preview transform
    • Start transform
    • Stop transforms
    • Update transform
  • Usage API
  • Watcher APIs
    • Ack watch
    • Activate watch
    • Deactivate watch
    • Delete watch
    • Execute watch
    • Get watch
    • Get Watcher stats
    • Query watches
    • Put watch
    • Start watch service
    • Stop watch service
  • Definitions
    • Role mapping resources
  • Migration guide
  • Dependencies and versions