opensearch-docs-cn/_opensearch/rest-api/cat/cat-templates.md

54 lines
1.2 KiB
Markdown
Raw Normal View History

2021-06-22 02:13:40 -04:00
---
layout: default
title: cat templates
parent: CAT API
2021-06-22 02:13:40 -04:00
grand_parent: REST API reference
nav_order: 70
has_children: false
---
# cat templates
2021-07-26 19:14:22 -04:00
Introduced 1.0
{: .label .label-purple }
2021-06-22 02:13:40 -04:00
The cat templates operation lists the names, patterns, order numbers, and version numbers of index templates.
## Example
```
GET _cat/templates?v
```
If you want to get information for a specific template or pattern:
2021-06-22 02:13:40 -04:00
```
GET _cat/templates/{name}
2021-06-22 02:13:40 -04:00
```
## Path and HTTP methods
```
GET _cat/templates
```
## URL parameters
All cat templates URL parameters are optional.
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index), you can specify the following parameter:
2021-06-22 02:13:40 -04:00
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.
2021-06-22 02:13:40 -04:00
## Response
```
name | index_patterns order version composed_of
tenant_template | [opensearch-dashboards*] | 0 |
2021-06-22 02:13:40 -04:00
```
To learn more about index templates, see [Index templates]({{site.url}}{{site.baseurl}}/opensearch/index-templates).