add operation to titles to differentiate from the API group acronym (#1750)
* add operation to titles to differentiate from the API group acronym Signed-off-by: alicejw <alicejw@amazon.com> * update frontmatter with new page title Signed-off-by: alicejw <alicejw@amazon.com> * for updates per issue https://github.com/opensearch-project/documentation-website/issues/1713 Signed-off-by: alicejw <alicejw@amazon.com> * to rename section title in left nav TOC to remove acronym definition and update each page frontmatter accordingly Signed-off-by: alicejw <alicejw@amazon.com> * to update page title per AWS Style Guide suggestion to only spell out the acronym the first time it's used in a sentence, not on the page title Signed-off-by: alicejw <alicejw@amazon.com> Signed-off-by: alicejw <alicejw@amazon.com>
This commit is contained in:
Alice Williams
GitHub
parent
5557a80f61
commit
fe8d702ca9
|
|
@ -1,17 +1,17 @@
|
|||
---
|
||||
layout: default
|
||||
title: cat aliases
|
||||
parent: Compact and aligned text (CAT) API
|
||||
title: CAT aliases
|
||||
parent: CAT API
|
||||
|
||||
nav_order: 1
|
||||
has_children: false
|
||||
---
|
||||
|
||||
# cat aliases
|
||||
# CAT aliases
|
||||
Introduced 1.0
|
||||
{: .label .label-purple }
|
||||
|
||||
The cat aliases operation lists the mapping of aliases to indices, plus routing and filtering information.
|
||||
The CAT aliases operation lists the mapping of aliases to indices, plus routing and filtering information.
|
||||
|
||||
## Example
|
||||
|
||||
|
|
@ -41,7 +41,7 @@ GET _cat/aliases
|
|||
|
||||
## URL parameters
|
||||
|
||||
All cat aliases URL parameters are optional.
|
||||
All CAT aliases URL parameters are optional.
|
||||
|
||||
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
|
||||
|
||||
|
|
@ -57,7 +57,7 @@ The following response shows that `alias1` refers to a `movies` index and has a
|
|||
```json
|
||||
alias | index | filter | routing.index | routing.search | is_write_index
|
||||
alias1 | movies | * | - | - | -
|
||||
.kibana | .kibana_1 | - | - | - | -
|
||||
.opensearch-dashboards | .opensearch-dashboards_1 | - | - | - | -
|
||||
```
|
||||
|
||||
To learn more about index aliases, see [Index aliases]({{site.url}}{{site.baseurl}}/opensearch/index-alias).
|
||||
|
|
|
|||
|
|
@ -1,17 +1,17 @@
|
|||
---
|
||||
layout: default
|
||||
title: cat allocation
|
||||
parent: Compact and aligned text (CAT) API
|
||||
title: CAT allocation
|
||||
parent: CAT API
|
||||
|
||||
nav_order: 5
|
||||
has_children: false
|
||||
---
|
||||
|
||||
# cat allocation
|
||||
# CAT allocation
|
||||
Introduced 1.0
|
||||
{: .label .label-purple }
|
||||
|
||||
The cat allocation operation lists the allocation of disk space for indices and the number of shards on each node.
|
||||
The CAT allocation operation lists the allocation of disk space for indices and the number of shards on each node.
|
||||
|
||||
## Example
|
||||
|
||||
|
|
@ -40,7 +40,7 @@ GET _cat/allocation/<node_name>
|
|||
|
||||
## URL parameters
|
||||
|
||||
All cat allocation URL parameters are optional.
|
||||
All CAT allocation URL parameters are optional.
|
||||
|
||||
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
|
||||
|
||||
|
|
@ -48,10 +48,7 @@ Parameter | Type | Description
|
|||
:--- | :--- | :---
|
||||
bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
|
||||
local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
|
||||
master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
|
||||
|
||||
|
||||
|
||||
cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds.
|
||||
## Response
|
||||
|
||||
The following response shows that 8 shards are allocated to each the two nodes available:
|
||||
|
|
|
|||
|
|
@ -1,17 +1,17 @@
|
|||
---
|
||||
layout: default
|
||||
title: cat cluster manager
|
||||
parent: Compact and aligned text (CAT) API
|
||||
title: CAT cluster manager
|
||||
parent: CAT API
|
||||
|
||||
nav_order: 30
|
||||
has_children: false
|
||||
---
|
||||
|
||||
# cat cluster_manager
|
||||
# CAT cluster_manager
|
||||
Introduced 1.0
|
||||
{: .label .label-purple }
|
||||
|
||||
The cat cluster manager operation lists information that helps identify the elected cluster manager node.
|
||||
The CAT cluster manager operation lists information that helps identify the elected cluster manager node.
|
||||
|
||||
## Example
|
||||
|
||||
|
|
@ -27,15 +27,13 @@ GET _cat/cluster_manager
|
|||
|
||||
## URL parameters
|
||||
|
||||
All cat cluster manager URL parameters are optional.
|
||||
All CAT cluster manager URL parameters are optional.
|
||||
|
||||
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
|
||||
|
||||
Parameter | Type | Description
|
||||
:--- | :--- | :---
|
||||
cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds.
|
||||
|
||||
|
||||
## Response
|
||||
|
||||
```json
|
||||
|
|
|
|||
|
|
@ -1,17 +1,17 @@
|
|||
---
|
||||
layout: default
|
||||
title: cat count
|
||||
parent: Compact and aligned text (CAT) API
|
||||
title: CAT count
|
||||
parent: CAT API
|
||||
|
||||
nav_order: 10
|
||||
has_children: false
|
||||
---
|
||||
|
||||
# cat count
|
||||
# CAT count
|
||||
Introduced 1.0
|
||||
{: .label .label-purple }
|
||||
|
||||
The cat count operation lists the number of documents in your cluster.
|
||||
The CAT count operation lists the number of documents in your cluster.
|
||||
|
||||
## Example
|
||||
|
||||
|
|
@ -40,7 +40,7 @@ GET _cat/count/<index>?v
|
|||
|
||||
## URL parameters
|
||||
|
||||
All cat count URL parameters are optional. You can specify any of the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index).
|
||||
All CAT count URL parameters are optional. You can specify any of the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index).
|
||||
|
||||
|
||||
## Response
|
||||
|
|
|
|||
|
|
@ -1,17 +1,17 @@
|
|||
---
|
||||
layout: default
|
||||
title: cat field data
|
||||
parent: Compact and aligned text (CAT) API
|
||||
title: CAT field data
|
||||
parent: CAT API
|
||||
|
||||
nav_order: 15
|
||||
has_children: false
|
||||
---
|
||||
|
||||
# cat fielddata
|
||||
# CAT fielddata
|
||||
Introduced 1.0
|
||||
{: .label .label-purple }
|
||||
|
||||
The cat fielddata operation lists the memory size used by each field per node.
|
||||
The CAT fielddata operation lists the memory size used by each field per node.
|
||||
|
||||
## Example
|
||||
|
||||
|
|
@ -40,7 +40,7 @@ GET _cat/fielddata/<field_name>?v
|
|||
|
||||
## URL parameters
|
||||
|
||||
All cat fielddata URL parameters are optional.
|
||||
All CAT fielddata URL parameters are optional.
|
||||
|
||||
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameter:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,17 +1,17 @@
|
|||
---
|
||||
layout: default
|
||||
title: cat health
|
||||
parent: Compact and aligned text (CAT) API
|
||||
title: CAT health
|
||||
parent: CAT API
|
||||
|
||||
nav_order: 20
|
||||
has_children: false
|
||||
---
|
||||
|
||||
# cat health
|
||||
# CAT health
|
||||
Introduced 1.0
|
||||
{: .label .label-purple }
|
||||
|
||||
The cat health operation lists the status of the cluster, how long the cluster has been up, the number of nodes, and other useful information that helps you analyze the health of your cluster.
|
||||
The CAT health operation lists the status of the cluster, how long the cluster has been up, the number of nodes, and other useful information that helps you analyze the health of your cluster.
|
||||
|
||||
## Example
|
||||
|
||||
|
|
@ -27,7 +27,7 @@ GET _cat/health?v
|
|||
|
||||
## URL parameters
|
||||
|
||||
All cat health URL parameters are optional.
|
||||
All CAT health URL parameters are optional.
|
||||
|
||||
Parameter | Type | Description
|
||||
:--- | :--- | :---
|
||||
|
|
|
|||
|
|
@ -1,17 +1,17 @@
|
|||
---
|
||||
layout: default
|
||||
title: cat indices
|
||||
parent: Compact and aligned text (CAT) API
|
||||
title: CAT indices operation
|
||||
parent: CAT API
|
||||
|
||||
nav_order: 25
|
||||
has_children: false
|
||||
---
|
||||
|
||||
# cat indices
|
||||
# CAT indices
|
||||
Introduced 1.0
|
||||
{: .label .label-purple }
|
||||
|
||||
The cat indices operation lists information related to indices—how much disk space they are using, how many shards they have, their health status, and so on.
|
||||
The CAT indices operation lists information related to indices—how much disk space they are using, how many shards they have, their health status, and so on.
|
||||
|
||||
## Example
|
||||
|
||||
|
|
@ -40,7 +40,7 @@ GET _cat/indices
|
|||
|
||||
## URL parameters
|
||||
|
||||
All cat indices URL parameters are optional.
|
||||
All CAT indices URL parameters are optional.
|
||||
|
||||
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
|
||||
|
||||
|
|
@ -49,7 +49,7 @@ Parameter | Type | Description
|
|||
bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
|
||||
health | String | Limit indices based on their health status. Supported values are `green`, `yellow`, and `red`.
|
||||
include_unloaded_segments | Boolean | Whether to include information from segments not loaded into memory. Default is false.
|
||||
master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
|
||||
cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds.
|
||||
pri | Boolean | Whether to return information only from the primary shards. Default is false.
|
||||
time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
|
||||
expand_wildcards | Enum | Expands wildcard expressions to concrete indices. Combine multiple values with commas. Supported values are `all`, `open`, `closed`, `hidden`, and `none`. Default is `open`.
|
||||
|
|
|
|||
|
|
@ -1,17 +1,17 @@
|
|||
---
|
||||
layout: default
|
||||
title: cat nodeattrs
|
||||
parent: Compact and aligned text (CAT) API
|
||||
title: CAT nodeattrs
|
||||
parent: CAT API
|
||||
|
||||
nav_order: 35
|
||||
has_children: false
|
||||
---
|
||||
|
||||
# cat nodeattrs
|
||||
# CAT nodeattrs
|
||||
Introduced 1.0
|
||||
{: .label .label-purple }
|
||||
|
||||
The cat nodeattrs operation lists the attributes of custom nodes.
|
||||
The CAT nodeattrs operation lists the attributes of custom nodes.
|
||||
|
||||
## Example
|
||||
|
||||
|
|
@ -27,14 +27,14 @@ GET _cat/nodeattrs
|
|||
|
||||
## URL parameters
|
||||
|
||||
All cat nodeattrs URL parameters are optional.
|
||||
All CAT nodeattrs URL parameters are optional.
|
||||
|
||||
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
|
||||
|
||||
Parameter | Type | Description
|
||||
:--- | :--- | :---
|
||||
local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
|
||||
master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
|
||||
cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds.
|
||||
|
||||
|
||||
## Response
|
||||
|
|
|
|||
|
|
@ -1,17 +1,17 @@
|
|||
---
|
||||
layout: default
|
||||
title: cat nodes
|
||||
parent: Compact and aligned text (CAT) API
|
||||
title: CAT nodes operation
|
||||
parent: CAT API
|
||||
|
||||
nav_order: 40
|
||||
has_children: false
|
||||
---
|
||||
|
||||
# cat nodes
|
||||
# CAT nodes
|
||||
Introduced 1.0
|
||||
{: .label .label-purple }
|
||||
|
||||
The cat nodes operation lists node-level information, including node roles and load metrics.
|
||||
The CAT nodes operation lists node-level information, including node roles and load metrics.
|
||||
|
||||
A few important node metrics are `pid`, `name`, `cluster_manager`, `ip`, `port`, `version`, `build`, `jdk`, along with `disk`, `heap`, `ram`, and `file_desc`.
|
||||
|
||||
|
|
@ -29,7 +29,7 @@ GET _cat/nodes
|
|||
|
||||
## URL parameters
|
||||
|
||||
All cat nodes URL parameters are optional.
|
||||
All CAT nodes URL parameters are optional.
|
||||
|
||||
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,17 +1,17 @@
|
|||
---
|
||||
layout: default
|
||||
title: cat pending tasks
|
||||
parent: Compact and aligned text (CAT) API
|
||||
title: CAT pending tasks
|
||||
parent: CAT API
|
||||
|
||||
nav_order: 45
|
||||
has_children: false
|
||||
---
|
||||
|
||||
# cat pending tasks
|
||||
# CAT pending tasks
|
||||
Introduced 1.0
|
||||
{: .label .label-purple }
|
||||
|
||||
The cat pending tasks operation lists the progress of all pending tasks, including task priority and time in queue.
|
||||
The CAT pending tasks operation lists the progress of all pending tasks, including task priority and time in queue.
|
||||
|
||||
## Example
|
||||
|
||||
|
|
@ -27,7 +27,7 @@ GET _cat/pending_tasks
|
|||
|
||||
## URL parameters
|
||||
|
||||
All cat nodes URL parameters are optional.
|
||||
All CAT nodes URL parameters are optional.
|
||||
|
||||
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
|
||||
|
||||
|
|
@ -37,7 +37,6 @@ local | Boolean | Whether to return information from the local node only instead
|
|||
cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds.
|
||||
time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
|
||||
|
||||
|
||||
## Response
|
||||
|
||||
```json
|
||||
|
|
|
|||
|
|
@ -1,17 +1,17 @@
|
|||
---
|
||||
layout: default
|
||||
title: cat plugins
|
||||
parent: Compact and aligned text (CAT) API
|
||||
title: CAT plugins
|
||||
parent: CAT API
|
||||
|
||||
nav_order: 50
|
||||
has_children: false
|
||||
---
|
||||
|
||||
# cat plugins
|
||||
# CAT plugins
|
||||
Introduced 1.0
|
||||
{: .label .label-purple }
|
||||
|
||||
The cat plugins operation lists the names, components, and versions of the installed plugins.
|
||||
The CAT plugins operation lists the names, components, and versions of the installed plugins.
|
||||
|
||||
## Example
|
||||
|
||||
|
|
@ -27,15 +27,14 @@ GET _cat/plugins
|
|||
|
||||
## URL parameters
|
||||
|
||||
All cat plugins URL parameters are optional.
|
||||
All CAT plugins URL parameters are optional.
|
||||
|
||||
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
|
||||
|
||||
Parameter | Type | Description
|
||||
:--- | :--- | :---
|
||||
local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false.
|
||||
master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
|
||||
|
||||
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
|
||||
|
||||
|
|
|
|||
|
|
@ -1,17 +1,17 @@
|
|||
---
|
||||
layout: default
|
||||
title: cat recovery
|
||||
parent: Compact and aligned text (CAT) API
|
||||
title: CAT recovery
|
||||
parent: CAT API
|
||||
|
||||
nav_order: 50
|
||||
has_children: false
|
||||
---
|
||||
|
||||
# cat recovery
|
||||
# CAT recovery
|
||||
Introduced 1.0
|
||||
{: .label .label-purple }
|
||||
|
||||
The cat recovery operation lists all completed and ongoing index and shard recoveries.
|
||||
The CAT recovery operation lists all completed and ongoing index and shard recoveries.
|
||||
|
||||
## Example
|
||||
|
||||
|
|
@ -39,7 +39,7 @@ GET _cat/recovery
|
|||
|
||||
## URL parameters
|
||||
|
||||
All cat recovery URL parameters are optional.
|
||||
All CAT recovery URL parameters are optional.
|
||||
|
||||
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,17 +1,17 @@
|
|||
---
|
||||
layout: default
|
||||
title: cat repositories
|
||||
parent: Compact and aligned text (CAT) API
|
||||
title: CAT repositories
|
||||
parent: CAT API
|
||||
|
||||
nav_order: 55
|
||||
has_children: false
|
||||
---
|
||||
|
||||
# cat repositories
|
||||
# CAT repositories
|
||||
Introduced 1.0
|
||||
{: .label .label-purple }
|
||||
|
||||
The cat repositories operation lists all completed and ongoing index and shard recoveries.
|
||||
The CAT repositories operation lists all completed and ongoing index and shard recoveries.
|
||||
|
||||
## Example
|
||||
|
||||
|
|
@ -27,7 +27,7 @@ GET _cat/repositories
|
|||
|
||||
## URL parameters
|
||||
|
||||
All cat repositories URL parameters are optional.
|
||||
All CAT repositories URL parameters are optional.
|
||||
|
||||
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,13 +1,13 @@
|
|||
---
|
||||
layout: default
|
||||
title: cat segments
|
||||
parent: Compact and aligned text (CAT) API
|
||||
title: CAT segments
|
||||
parent: CAT API
|
||||
|
||||
nav_order: 55
|
||||
has_children: false
|
||||
---
|
||||
|
||||
# cat segments
|
||||
# CAT segments
|
||||
Introduced 1.0
|
||||
{: .label .label-purple }
|
||||
|
||||
|
|
@ -39,7 +39,7 @@ GET _cat/segments
|
|||
|
||||
## URL parameters
|
||||
|
||||
All cat segments URL parameters are optional.
|
||||
All CAT segments URL parameters are optional.
|
||||
|
||||
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameter:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,17 +1,17 @@
|
|||
---
|
||||
layout: default
|
||||
title: cat shards
|
||||
parent: Compact and aligned text (CAT) API
|
||||
title: CAT shards
|
||||
parent: CAT API
|
||||
|
||||
nav_order: 60
|
||||
has_children: false
|
||||
---
|
||||
|
||||
# cat shards
|
||||
# CAT shards
|
||||
Introduced 1.0
|
||||
{: .label .label-purple }
|
||||
|
||||
The cat shards operation lists the state of all primary and replica shards and how they are distributed.
|
||||
The CAT shards operation lists the state of all primary and replica shards and how they are distributed.
|
||||
|
||||
## Example
|
||||
|
||||
|
|
|
|||
|
|
@ -1,17 +1,17 @@
|
|||
---
|
||||
layout: default
|
||||
title: cat snapshots
|
||||
parent: Compact and aligned text (CAT) API
|
||||
title: CAT snapshots
|
||||
parent: CAT API
|
||||
|
||||
nav_order: 65
|
||||
has_children: false
|
||||
---
|
||||
|
||||
# cat snapshots
|
||||
# CAT snapshots
|
||||
Introduced 1.0
|
||||
{: .label .label-purple }
|
||||
|
||||
The cat snapshots operation lists all snapshots for a repository.
|
||||
The CAT snapshots operation lists all snapshots for a repository.
|
||||
|
||||
## Example
|
||||
|
||||
|
|
@ -27,13 +27,13 @@ GET _cat/snapshots
|
|||
|
||||
## URL parameters
|
||||
|
||||
All cat snapshots URL parameters are optional.
|
||||
All CAT snapshots URL parameters are optional.
|
||||
|
||||
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameter:
|
||||
|
||||
Parameter | Type | Description
|
||||
:--- | :--- | :---
|
||||
master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
|
||||
cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds.
|
||||
time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,17 +1,17 @@
|
|||
---
|
||||
layout: default
|
||||
title: cat tasks
|
||||
parent: Compact and aligned text (CAT) API
|
||||
title: CAT tasks
|
||||
parent: CAT API
|
||||
|
||||
nav_order: 70
|
||||
has_children: false
|
||||
---
|
||||
|
||||
# cat tasks
|
||||
# CAT tasks
|
||||
Introduced 1.0
|
||||
{: .label .label-purple }
|
||||
|
||||
The cat tasks operation lists the progress of all tasks currently running on your cluster.
|
||||
The CAT tasks operation lists the progress of all tasks currently running on your cluster.
|
||||
|
||||
## Example
|
||||
|
||||
|
|
@ -27,7 +27,7 @@ GET _cat/tasks
|
|||
|
||||
## URL parameters
|
||||
|
||||
All cat tasks URL parameters are optional.
|
||||
All CAT tasks URL parameters are optional.
|
||||
|
||||
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameter:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,17 +1,17 @@
|
|||
---
|
||||
layout: default
|
||||
title: cat templates
|
||||
parent: Compact and aligned text (CAT) API
|
||||
title: CAT templates
|
||||
parent: CAT API
|
||||
|
||||
nav_order: 70
|
||||
has_children: false
|
||||
---
|
||||
|
||||
# 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.
|
||||
The CAT Templates operation lists the names, patterns, order numbers, and version numbers of index templates.
|
||||
|
||||
## Example
|
||||
|
||||
|
|
@ -33,7 +33,7 @@ GET _cat/templates
|
|||
|
||||
## URL parameters
|
||||
|
||||
All cat templates URL parameters are optional.
|
||||
All CAT templates URL parameters are optional.
|
||||
|
||||
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameter:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,16 +1,16 @@
|
|||
---
|
||||
layout: default
|
||||
title: cat thread pool
|
||||
parent: Compact and aligned text (CAT) API
|
||||
title: CAT thread pool
|
||||
parent: CAT API
|
||||
nav_order: 75
|
||||
has_children: false
|
||||
---
|
||||
|
||||
# cat thread pool
|
||||
# CAT thread pool
|
||||
Introduced 1.0
|
||||
{: .label .label-purple }
|
||||
|
||||
The Cat thread pool operation lists the active, queued, and rejected threads of different thread pools on each node.
|
||||
The CAT thread pool operation lists the active, queued, and rejected threads of different thread pools on each node.
|
||||
|
||||
## Example
|
||||
|
||||
|
|
@ -32,7 +32,7 @@ GET _cat/thread_pool
|
|||
|
||||
## URL parameters
|
||||
|
||||
All cat thread pool URL parameters are optional.
|
||||
All CAT thread pool URL parameters are optional.
|
||||
|
||||
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameter:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
layout: default
|
||||
title: Compact and aligned text (CAT) API
|
||||
title: CAT API
|
||||
nav_order: 10
|
||||
has_children: true
|
||||
redirect_from:
|
||||
|
|
@ -8,15 +8,15 @@ redirect_from:
|
|||
- /opensearch/rest-api/cat
|
||||
---
|
||||
|
||||
# Compact and aligned text (CAT) API
|
||||
# CAT API
|
||||
|
||||
You can get essential statistics about your cluster in an easy-to-understand, tabular format using the compact and aligned text (CAT) API. The Cat API is a human-readable interface that returns plain text instead of traditional JSON.
|
||||
You can get essential statistics about your cluster in an easy-to-understand, tabular format using the compact and aligned text (CAT) API. The CAT API is a human-readable interface that returns plain text instead of traditional JSON.
|
||||
|
||||
Using the Cat API, you can answer questions like which node is the elected master, what state is the cluster in, how many documents are in each index, and so on.
|
||||
Using the CAT API, you can answer questions like which node is the elected master, what state is the cluster in, how many documents are in each index, and so on.
|
||||
|
||||
## Example
|
||||
|
||||
To see the available operations in the Cat API, use the following command:
|
||||
To see the available operations in the CAT API, use the following command:
|
||||
|
||||
```
|
||||
GET _cat
|
||||
|
|
@ -24,7 +24,7 @@ GET _cat
|
|||
|
||||
## Optional query parameters
|
||||
|
||||
You can use the following query parameters with any Cat API to filter your results.
|
||||
You can use the following query parameters with any CAT API to filter your results.
|
||||
|
||||
Parameter | Description
|
||||
:--- | :--- |
|
||||
|
|
@ -36,7 +36,7 @@ Parameter | Description
|
|||
|
||||
### Query parameter usage examples
|
||||
|
||||
You can specify a query parameter to any Cat operation to obtain more specific results.
|
||||
You can specify a query parameter to any CAT operation to obtain more specific results.
|
||||
|
||||
### Get verbose output
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue