Create Index

Create Index API 用于手动创建索引。Scope 中的所有文档都存储在一个或多个索引中。

最基本的命令如下：

curl -X PUT "localhost:9200/twitter?pretty"

上述命令创建了一个名为 twitter 的索引。

curl -X PUT "localhost:9200/twitter?pretty"

{
  "acknowledged" : true,
  "shards_acknowledged" : true,
  "index" : "twitter"
}

Index name limitations

索引的命名有几个限制：

仅小写
不能包含 \、/、*、?、"、<、>、|、（空格字符）、,、#
不能以 -、_、+ 开头
不可能是 . 或者 ..
不能超过255个字节

Index Settings

创建的每个索引都可以具有与之关联的特定设置：

PUT twitter
{
    "settings" : {
        "index" : {
            "number_of_shards" : 3,
            "number_of_replicas" : 2
        }
    }
}

或者

PUT twitter
{
    "settings" : {
        "number_of_shards" : 3,
        "number_of_replicas" : 2
    }
}

Mappings

Create Index API 还允许提供 Mapping：

PUT test
{
    "settings" : {
        "number_of_shards" : 1
    },
    "mappings" : {
        "_doc" : {
            "properties" : {
                "field1" : { "type" : "text" }
            }
        }
    }
}

Aliases

Create Index API 还允许提供一组别名：

PUT test
{
    "aliases" : {
        "alias_1" : {},
        "alias_2" : {
            "filter" : {
                "term" : {"user" : "kimchy" }
            },
            "routing" : "kimchy"
        }
    }
}

Wait For Active Shards

默认情况下，索引创建只会在每个分片的主副本已启动或请求超时时才向客户端返回响应

{
    "acknowledged": true,
    "shards_acknowledged": true,
    "index": "test"
}

acknowledged 表明是否在集群中成功创建索引，而 shards_acknowledged 指示是否在超时之前为索引中的每个分片启动了必要数量的分片副本。请注意，即使索引创建成功，acknowledged 或 shards_acknowledged 也仍然可能为 false。这些值仅表示操作是否在超时之前完成。如果 acknowledged 为 false，那么我们在使用新创建的索引更新集群状态之前就超时了，但它可能很快就会被创建。如果 shards_acknowledged 为 false，那么即使集群状态已成功更新以反映新创建的索引（即，acknowledged = true），也会在启动所需数量的分片之前超时（默认情况下只是主分片）。

我们可以通过索引设置 index.write.wait_for_active_shards 更改默认只等待主分片启动（注意更改此设置也会影响所有后续写入操作的 wait_for_active_shards 值）

PUT test
{
    "settings": {
        "index.write.wait_for_active_shards": "2"
    }
}

或者也可以这样

PUT test?wait_for_active_shards=2

Delete Index

Delete Index API 允许删除现有索引。

DELETE /twitter

curl -X DELETE "localhost:9200/test/?pretty"
{
  "acknowledged" : true
}

上面的示例删除了一个名为 test 的索引。

Get Index

get index API 允许检索有关一个或多个索引的信息。

GET /twitter

上面的示例获取名为 twitter 的索引的信息。

curl -X GET "localhost:9200/test?pretty"
{
    "test" : {
        "aliases" : { },
        "mappings" : {
            "default_type_" : { "properties" : { } }
        },
        "settings" : {
            "index" : { "number_of_shards" : "5",
                        "number_of_replicas" : "3",
                        "creation_date" : "2022-05-09 21:04:42" }
        }
    }
}

expand_wildcards：控制通配符索引表达式可以扩展到哪种具体索引。如果指定了 open，则通配符表达式将扩展为仅打开的索引。如果指定了 closed，则通配符表达式仅扩展为关闭索引。也可以指定两个值（open，closed）以扩展到所有索引。

如果指定为 null，则通配符扩展将被禁用。如果指定了 all，通配符表达式将扩展到所有索引（这相当于指定 open,closed）

Indices Exists

检查 index 是否存在，HTTP 状态码返回 200 表示存在，404 表示不存在。

HEAD twitter

curl -I "localhost:9200/_alias/2016?pretty"

HTTP/1.1 200 OK
content-type: application/json; charset=UTF-8
content-length: 73

Put Mapping

put mapping API 允许将字段添加到现有索引。

PUT twitter {}

PUT twitter/_mapping/_doc
{
    "properties": {
        "email": { "type": "keyword" }
    }
}

curl -X PUT "localhost:9200/twitter/_mapping/_doc?pretty" -H 'Content-Type: application/json' -d'
{
    "properties": {
        "email": { "type": "keyword" }
    }
}'

{
  "acknowledged" : true
}

Multi-index

put mapping API 可以通过单个请求应用于多个索引。例如，我们可以同时更新 twitter-1 和 twitter-2 的 mapping：

PUT twitter-1

PUT twitter-2

PUT /twitter-1,twitter-2/_mapping/_doc
{
    "properties": {
        "user_name": { "type": "text" }
    }
}

Updating field mappings

通常，无法更新现有字段的 mapping。但是这条规则有一些例外。例如：

可以将 new properties 添加到对象数据类型字段。可以将新的 multi-fields 添加到现有字段。 ignore_above 参数可以更新

PUT my_index
{
  "mappings": {
    "_doc": {
      "properties": {
        "name": {
          "properties": {
            "first": {
              "type": "text"
            }
          }
        },
        "user_id": {
          "type": "keyword"
        }
      }
    }
  }
}

PUT my_index/_mapping/_doc
{
  "properties": {
    "name": {
      "properties": {
        "last": {
          "type": "text"
        }
      }
    },
    "user_id": {
      "type": "keyword",
      "ignore_above": 100
    }
  }
}

Get Mapping

get mapping API 允许检索索引或索引/类型的 mapping。

GET /twitter/_mapping

curl -X GET "localhost:9200/my_index/_mapping?pretty"
{
  "my_index" : {
    "mappings" : {
      "default_type_" : {
        "properties" : {
          "name" : {
            "type" : "object"
          },
          "user_id" : {
            "type" : "keyword"
          }
        }
      }
    }
  }
}

Index Aliases

Scope 中 index aliases API 允许使用名称为索引设置别名，所有 API 都会自动将别名转换为实际的索引名称。一个别名也可以映射到多个索引，当指定它时，别名会自动扩展为别名索引。别名也可以与搜索时自动应用的过滤器和路由值相关联。别名不能与索引同名。

以下是将别名 alias1 与索引 test1 关联的示例：

POST /_aliases
{
    "actions" : [
        { "add" : { "index" : "test1", "alias" : "alias1" } }
    ]
}

curl -X POST "localhost:9200/_aliases?pretty" -H 'Content-Type: application/json' -d'
{
     "actions" : [
         { "add" : { "index" : "test1", "alias" : "alias1" } }
     ]
}'

{
  "acknowledged" : true
}

以下是移除别名 alias1 与索引 test1 的关联

POST /_aliases
{
    "actions" : [
        { "remove" : { "index" : "test1", "alias" : "alias1" } }
    ]
}

重命名别名是在同一个 API 中简单的删除然后添加操作。这个操作是原子的，不用担心别名不指向索引的短时间内：

POST /_aliases
{
    "actions" : [
        { "remove" : { "index" : "test1", "alias" : "alias1" } },
        { "add" : { "index" : "test2", "alias" : "alias1" } }
    ]
}

将别名与多个索引相关联：

POST /_aliases
{
    "actions" : [
        { "add" : { "index" : "test1", "alias" : "alias1" } },
        { "add" : { "index" : "test2", "alias" : "alias1" } }
    ]
}

可以使用索引数组语法为动作指定多个索引：

POST /_aliases
{
    "actions" : [
        { "add" : { "indices" : ["test1", "test2"], "alias" : "alias1" } }
    ]
}

要在一个操作中指定多个别名，相应的别名数组语法也存在。

对于上面的示例，glob 模式也可用于将别名与多个共享同一个名称的索引相关联：

POST /_aliases
{
    "actions" : [
        { "add" : { "index" : "test*", "alias" : "all_test_indices" } }
    ]
}

在这种情况下将对所有匹配的当前索引进行分组，它不会随着与此模式匹配的新索引的添加/删除而自动更新。

Filtered Aliases

带有过滤器的别名提供了一种简单的方法来创建同一索引的不同“视图”。

要创建过滤别名，首先我们需要确保 mapping 中已经存在字段：

PUT /test1
{
  "mappings": {
    "_doc": {
      "properties": {
        "user" : {
          "type": "keyword"
        }
      }
    }
  }
}

现在我们可以创建一个别名，对字段 user 使用过滤器：

POST /_aliases
{
    "actions" : [
        {
            "add" : {
                 "index" : "test1",
                 "alias" : "alias2",
                 "filter" : { "term" : { "user" : "kimchy" } }
            }
        }
    ]
}

Routing

可以将路由值与别名相关联。此功能可以与过滤别名一起使用，以避免不必要的分片操作。

以下命令创建一个指向索引 test 的新别名 alias1。创建 alias1 后，所有具有此别名的操作都会自动修改为使用值 1 进行路由：

POST /_aliases
{
    "actions" : [
        {
            "add" : {
                 "index" : "test",
                 "alias" : "alias1",
                 "routing" : "1"
            }
        }
    ]
}

也可以为搜索和索引操作指定不同的路由值：

POST /_aliases
{
    "actions" : [
        {
            "add" : {
                 "index" : "test",
                 "alias" : "alias2",
                 "search_routing" : "1,2",
                 "index_routing" : "2"
            }
        }
    ]
}

Write Index

可以将别名指向的索引关联为写索引。指定后，针对指向多个索引的别名的所有索引和更新请求都将尝试解析为写入索引的一个索引。每个别名一次只能分配一个索引作为写入索引。如果没有指定写入索引并且有多个索引被别名引用，则不允许写入。

Aliases during index creation

PUT /logs_20162801
{
    "mappings" : {
        "_doc" : {
            "properties" : {
                "year" : {"type" : "integer"}
            }
        }
    },
    "aliases" : {
        "current_day" : {},
        "2016" : {
            "filter" : {
                "term" : {"year" : 2016 }
            }
        }
    }
}

Retrieving existing aliases

get index alias API 允许按别名和索引名称进行过滤。此 api 重定向到 master 并获取请求的索引别名（如果可用）。此 api 仅序列化找到的索引别名。

GET /logs_20162801/_alias/*

GET /_alias/2016

GET /_alias/20*

Update Indices Settings

实时更改特定的索引级别设置。

REST 端点是 /_settings（更新所有索引）或 {index}/_settings 更新一个（或多个）索引设置。

PUT /twitter/_settings
{
    "index" : {
        "number_of_replicas" : 2
    }
}

curl -X PUT "localhost:9200/twitter/_settings?pretty" -H 'Content-Type: application/json' -d'
{
    "index" : {
        "number_of_replicas" : 2
    }
}
'

{
  "acknowledged" : true
}

要将设置重置为默认值，请使用 null。

PUT /twitter/_settings
{
    "index" : {
        "refresh_interval" : null
    }
}

Get Settings

get settings API 允许检索索引/索引的设置：

GET /twitter/_settings

curl -X GET "localhost:9200/twitter/_settings?pretty"
{
  "twitter" : {
    "settings" : {
      "index" : {
        "disk" : {
          "id" : "0"
        },
        "refresh_interval" : "1s",
        "number_of_shards" : "5",
        "creation_date" : "2022-05-09 22:50:10",
        "number_of_replicas" : "3",
        "version" : {
          "created" : "1000001"
        },
        "table" : {
          "id" : "79270321525d4d759a1be032cf1c4a99"
        }
      },
      "path" : {
        "conf" : "../lib/search.yml"
      },
      "disk" : {
        "id" : ""
      },
      "indices" : {
        "plugins" : {
          "config" : {
            "dir" : "/home/transwarp/mygit1/shiva/build/lib/plugins"
          }
        }
      }
    }
  }
}

Multiple Indices and Types

get settings API 可用于通过一次调用获取多个索引的设置。 API 的一般用法遵循以下语法：host:port/{index}/_settings 其中 {index} 可以代表以逗号分隔的索引名称和别名列表。还支持通配符表达式。以下是一些示例：

GET /twitter,kimchy/_settings

GET /log_2013_*/_settings

Index Templates

索引模板允许您定义将在创建新索引时自动应用的模板。模板包括 setting 和 mapping 以及控制是否应将模板应用于新索引的简单模式模板。

模板仅在创建索引时应用。更改模板不会影响现有索引。使用创建索引 API 时，作为创建索引调用的一部分定义的 settings/mappings 将优先于模板中定义的任何匹配 settings/mappings。

PUT _template/template_1
{
  "index_patterns": ["te*", "bar*"],
  "settings": {
    "number_of_shards": 1
  },
  "mappings": {
    "_doc": {
      "_source": {
        "enabled": false
      },
      "properties": {
        "host_name": {
          "type": "keyword"
        },
        "created_at": {
          "type": "date",
          "format": "EEE MMM dd HH:mm:ss Z yyyy"
        }
      }
    }
  }
}

curl -X PUT "localhost:9200/_template/template_1?pretty" -H 'Content-Type: application/json' -d'
{
   "index_patterns": ["te*", "bar*"],
   "settings": {
     "number_of_shards": 1
   },
   "mappings": {
     "_doc": {
       "_source": {
         "enabled": false
       },
       "properties": {
         "host_name": {
           "type": "keyword"
         },
         "created_at": {
           "type": "date",
           "format": "EEE MMM dd HH:mm:ss Z yyyy"
         }
       }
     }
   }
}'

{
  "acknowledged" : true
}

定义一个名为 template_1 的模板，模板模式为 te* 或 bar*。设置和 mapping 将应用于与 te* 或 bar* 模式匹配的任何索引名称。

也可以在索引模板中包含别名，如下所示：

PUT _template/template_1
{
    "index_patterns" : ["te*"],
    "settings" : {
        "number_of_shards" : 1
    },
    "aliases" : {
        "alias1" : {},
        "alias2" : {
            "filter" : {
                "term" : {"user" : "kimchy" }
            },
            "routing" : "kimchy"
        },
        "{index}-alias" : {}
    }
}

Deleting a Template

可以使用以下命令删除模板

DELETE /_template/template_1

Multiple Templates Matching

多个索引模板可能会匹配一个索引，在这种情况下，setting 和 mapping 都会合并到索引的最终配置中。可以使用 order 参数控制合并的顺序，首先应用较低的顺序，然后应用较高的顺序覆盖它们。例如：

PUT /_template/template_1
{
    "index_patterns" : ["*"],
    "order" : 0,
    "settings" : {
        "number_of_shards" : 1
    },
    "mappings" : {
        "_doc" : {
            "_source" : { "enabled" : false }
        }
    }
}

PUT /_template/template_2
{
    "index_patterns" : ["te*"],
    "order" : 1,
    "settings" : {
        "number_of_shards" : 1
    },
    "mappings" : {
        "_doc" : {
            "_source" : { "enabled" : true }
        }
    }
}

以上将禁用存储 _source，但对于以 te* 开头的索引，_source 仍将启用。请注意，对于 mapping，合并是“深度”的，这意味着可以在高阶模板上轻松添加/覆盖基于特定对象/属性的 mapping，而低阶模板提供基础。

Refresh

refresh API 允许显式刷新一个或多个索引，使自上次刷新以来执行的所有操作都可用于搜索。（接近）实时功能取决于所使用的索引引擎。

POST /twitter/_refresh

curl -X POST "localhost:9200/test/_refresh?pretty"
{
    "_shards" : { "total" : 3,
                  "successful" : 3,
                  "failed" : 0 }
}

Multi Index

refresh API 可以支持多个索引同时刷新

POST /kimchy,scope/_refresh

POST /_refresh

Open/Close Index

Open/Close Index API 允许关闭索引，然后再打开它。一个封闭的索引在集群上几乎没有开销（除了维护它的元数据），并且被阻塞用于读/写操作。可以打开一个已关闭的索引，然后该索引将通过正常的恢复过程。

最基本的命令如下：

curl -X PUT "localhost:9200/index/_open?pretty"

curl -X PUT "localhost:9200/index/_close?pretty"

# 打开名为index的索引
curl -X POST "localhost:9200/my_index/_close?pretty"

{
  "acknowledged" : true
}

# 关闭名为index的索引
curl -X POST "localhost:9200/my_index/_open?pretty"

{
  "acknowledged" : true
}

封闭索引会消耗大量磁盘空间，这可能会导致托管环境出现问题。