解析索引 API编辑

解析索引、别名和数据流的指定名称和/或索引模式。支持多种模式和远程集群。

response = client.indices.resolve_index(
  name: 'my-index-*'
)
puts response
GET /_resolve/index/my-index-*

请求编辑

GET /_resolve/index/<name>

先决条件编辑

  • 如果启用了 Elasticsearch 安全功能,则您必须具有目标数据流、索引或索引别名的 view_index_metadatamanage 索引权限

路径参数编辑

<name>

(必填,字符串)要解析的索引、别名和数据流的以逗号分隔的名称和/或索引模式,使用 多目标语法。可以使用 <cluster>:<name> 语法指定 远程集群 上的资源。

查询参数编辑

expand_wildcards

(可选,字符串)通配符模式可以匹配的索引类型。如果请求可以定位数据流,则此参数确定通配符表达式是否匹配隐藏数据流。支持逗号分隔的值,例如 open,hidden。有效值为

all
匹配任何数据流或索引,包括 隐藏的 数据流或索引。
open
匹配打开的、非隐藏的索引。也匹配任何非隐藏的数据流。
closed
匹配关闭的、非隐藏的索引。也匹配任何非隐藏的数据流。数据流不能关闭。
hidden
匹配隐藏的数据流和隐藏的索引。必须与 openclosed 或两者结合使用。
none
不接受通配符模式。

默认为 open

ignore_unavailable

(可选,布尔值)如果为 false,则如果请求的目标是丢失或关闭的索引,则该请求将返回错误。默认为 false

默认为 false

allow_no_indices

(可选,布尔值)如果为 false,则如果任何通配符表达式、索引别名_all 值仅定位到丢失或关闭的索引,则请求将返回错误。即使请求定位到其他打开的索引,也会应用此行为。例如,如果索引以 foo 开头但没有索引以 bar 开头,则定位到 foo*,bar* 的请求将返回错误。

默认为 true

ignore_throttled

(可选,布尔值)如果为 true,则在冻结时将忽略具体的、扩展的或别名索引。默认为 false

[7.16.0] 已弃用于 7.16.0。

示例编辑

response = client.indices.resolve_index(
  name: 'f*,remoteCluster1:bar*',
  expand_wildcards: 'all'
)
puts response
GET /_resolve/index/f*,remoteCluster1:bar*?expand_wildcards=all

API 返回以下响应

{
  "indices": [                                 
    {
      "name": "foo_closed",
      "attributes": [
        "closed"                               
      ]
    },
    {
      "name": "freeze-index",
      "aliases": [
        "f-alias"
      ],
      "attributes": [
        "open"
      ]
    },
    {
      "name": "remoteCluster1:bar-01",
      "attributes": [
        "open"
      ]
    }
  ],
  "aliases": [                                 
    {
      "name": "f-alias",
      "indices": [
        "freeze-index",
        "my-index-000001"
      ]
    }
  ],
  "data_streams": [                            
    {
      "name": "foo",
      "backing_indices": [
        ".ds-foo-2099.03.07-000001"
      ],
      "timestamp_field": "@timestamp"
    }
  ]
}

与提供的名称或表达式匹配的所有索引

可能的索引属性有 openclosedhiddensystemfrozen

与提供的名称或表达式匹配的所有别名

与提供的名称或表达式匹配的所有数据流