iSharkFly-Docs/opensearch-docs-cn
1
0
Fork 0
mirror of https://github.com/iSharkFly-Docs/opensearch-docs-cn synced 2025-03-01 04:49:05 +00:00
Code Issues Packages Projects Releases Wiki Activity
opensearch-docs-cn/_api-reference/cat/cat-templates.md
MUHAMMAD SAMIULLAH 84e4ab158e
[DOC] Format all API pages according to the API template (#5169) 
* Fix APIs File

Signed-off-by: samipak458 <samipak458@gmail.com>

* Update API files according to API template

Signed-off-by: samipak458 <samipak458@gmail.com>

* Update exec-stored-script.md

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Update cat-aliases.md

Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com>

* Update cat-allocation.md

Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com>

* Update cat-cluster_manager.md

Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com>

* Update cat-count.md

Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com>

* Update cat-field-data.md

Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com>

* Update cat-health.md

Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com>

* updated

* updated

* updated

---------

Signed-off-by: samipak458 <samipak458@gmail.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
2023-10-23 09:53:52 -05:00

1.4 KiB
Raw Blame History

layout title parent nav_order has_children redirect_from
default CAT templates CAT API 70 false
/opensearch/rest-api/cat/cat-templates/

CAT templates

Introduced 1.0 {: .label .label-purple }

The CAT templates operation lists the names, patterns, order numbers, and version numbers of index templates.

Example

GET _cat/templates?v

{% include copy-curl.html %}

If you want to get information for a specific template or pattern:

GET _cat/templates/<template_name_or_pattern>

{% include copy-curl.html %}

Path and HTTP methods

GET _cat/templates

{% include copy-curl.html %}

URL parameters

All CAT templates URL parameters are optional.

In addition to the common URL parameters, you can specify the following parameters:

Parameter Type Description
local Boolean Whether to return information from the local node only instead of from the cluster manager node. Default is false.
cluster_manager_timeout Time The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds.

Response

name | index_patterns order version composed_of
tenant_template | [opensearch-dashboards*] | 0  |

To learn more about index templates, see Index templates.