« GeoIP 统计 API 模拟管道 API »
Elastic 文档 ›Elasticsearch 指南 [8.14] ›REST API ›摄取 API

获取管道 API

编辑

获取管道 API编辑

返回有关一个或多个摄取管道的信息。此 API 返回管道的本地引用。

response = client.ingest.get_pipeline(
  id: 'my-pipeline-id'
)
puts response
GET /_ingest/pipeline/my-pipeline-id

请求编辑

GET /_ingest/pipeline/<pipeline>

GET /_ingest/pipeline

先决条件编辑

  • 如果启用了 Elasticsearch 安全功能，您必须具有 read_pipeline、manage_pipeline、manage_ingest_pipelines 或 manage 集群权限 才能使用此 API。

路径参数编辑

<pipeline>

(可选，字符串) 要检索的管道 ID 的逗号分隔列表。支持通配符 (*) 表达式。

要获取所有摄取管道，请省略此参数或使用 *。

查询参数编辑

master_timeout
(可选，时间单位) 等待主节点的时间段。如果在超时时间到期之前主节点不可用，则请求将失败并返回错误。默认值为 30s。也可以设置为 -1，表示请求永远不会超时。

示例编辑

获取特定摄取管道的 信息编辑

response = client.ingest.get_pipeline(
  id: 'my-pipeline-id'
)
puts response
GET /_ingest/pipeline/my-pipeline-id

API 返回以下响应

{
  "my-pipeline-id" : {
    "description" : "describe pipeline",
    "version" : 123,
    "processors" : [
      {
        "set" : {
          "field" : "foo",
          "value" : "bar"
        }
      }
    ]
  }
}
« GeoIP 统计 API 模拟管道 API »