原文地址: https://www.elastic.co/guide/en/elasticsearch/reference/7.7/cat-templates.html, 原文档版权归 www.elastic.co 所有
IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
cat templates APIedit
Returns information about index templates in a cluster. You can use index templates to apply index settings and field mappings to new indices at creation.
Path parametersedit
-
<template_name>
- (Optional, string) Comma-separated list of index template names used to limit the request. Accepts wildcard expressions.
Query parametersedit
-
format
- (Optional, string) Short version of the HTTP accept header. Valid values include JSON, YAML, etc.
-
h
- (Optional, string) Comma-separated list of column names to display.
-
help
-
(Optional, boolean) If
true
, the response includes help information. Defaults tofalse
. -
local
-
(Optional, boolean) If
true
, the request retrieves information from the local node only. Defaults tofalse
, which means information is retrieved from the master node. -
master_timeout
-
(Optional, time units) Specifies the period of time to wait for
a connection to the master node. If no response is received before the timeout
expires, the request fails and returns an error. Defaults to
30s
. -
s
- (Optional, string) Comma-separated list of column names or column aliases used to sort the response.
-
v
-
(Optional, boolean) If
true
, the response includes column headings. Defaults tofalse
.
Examplesedit
GET /_cat/templates?v&s=name
The API returns the following response:
name index_patterns order version template0 [te*] 0 template1 [tea*] 1 template2 [teak*] 2 7