CAT API redirects (#3965)
* catapi redirects Signed-off-by: Heather Halter <hdhalter@amazon.com> * data prepper redirects Signed-off-by: Heather Halter <hdhalter@amazon.com> * committing unsaved Signed-off-by: Heather Halter <hdhalter@amazon.com> --------- Signed-off-by: Heather Halter <hdhalter@amazon.com>
This commit is contained in:
parent
8ed9a9505b
commit
22cfcf119b
|
@ -2,6 +2,8 @@
|
|||
layout: default
|
||||
title: CAT aliases
|
||||
parent: CAT API
|
||||
redirect_from:
|
||||
- /opensearch/rest-api/cat/cat-aliases/
|
||||
|
||||
nav_order: 1
|
||||
has_children: false
|
||||
|
@ -11,7 +13,7 @@ has_children: false
|
|||
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 indexes, plus routing and filtering information.
|
||||
|
||||
## Example
|
||||
|
||||
|
|
|
@ -2,7 +2,8 @@
|
|||
layout: default
|
||||
title: CAT allocation
|
||||
parent: CAT API
|
||||
|
||||
redirect_from:
|
||||
- /opensearch/rest-api/cat/cat-allocation/
|
||||
nav_order: 5
|
||||
has_children: false
|
||||
---
|
||||
|
@ -11,7 +12,7 @@ has_children: false
|
|||
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 indexes and the number of shards on each node.
|
||||
|
||||
## Example
|
||||
|
||||
|
@ -55,7 +56,7 @@ cluster_manager_timeout | Time | The amount of time to wait for a connection to
|
|||
|
||||
## Response
|
||||
|
||||
The following response shows that eight shards are allocated to each the two nodes available:
|
||||
The following response shows that eight shards are allocated to each of the two nodes available:
|
||||
|
||||
```json
|
||||
shards | disk.indices | disk.used | disk.avail | disk.total | disk.percent host | ip | node
|
||||
|
|
|
@ -2,9 +2,11 @@
|
|||
layout: default
|
||||
title: CAT count
|
||||
parent: CAT API
|
||||
|
||||
nav_order: 10
|
||||
has_children: false
|
||||
redirect_from:
|
||||
- /opensearch/rest-api/cat/cat-count/
|
||||
|
||||
---
|
||||
|
||||
# CAT count
|
||||
|
|
|
@ -2,9 +2,10 @@
|
|||
layout: default
|
||||
title: CAT field data
|
||||
parent: CAT API
|
||||
|
||||
nav_order: 15
|
||||
has_children: false
|
||||
redirect_from:
|
||||
- /opensearch/rest-api/cat/cat-field-data/
|
||||
---
|
||||
|
||||
# CAT fielddata
|
||||
|
|
|
@ -5,6 +5,8 @@ parent: CAT API
|
|||
|
||||
nav_order: 20
|
||||
has_children: false
|
||||
redirect_from:
|
||||
- /opensearch/rest-api/cat/cat-health/
|
||||
---
|
||||
|
||||
# CAT health
|
||||
|
|
|
@ -2,16 +2,17 @@
|
|||
layout: default
|
||||
title: CAT indices operation
|
||||
parent: CAT API
|
||||
|
||||
nav_order: 25
|
||||
has_children: false
|
||||
redirect_from:
|
||||
- /opensearch/rest-api/cat/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 indexes, that is, how much disk space they are using, how many shards they have, their health status, and so on.
|
||||
|
||||
## Example
|
||||
|
||||
|
|
|
@ -2,9 +2,10 @@
|
|||
layout: default
|
||||
title: CAT nodeattrs
|
||||
parent: CAT API
|
||||
|
||||
nav_order: 35
|
||||
has_children: false
|
||||
redirect_from:
|
||||
- /opensearch/rest-api/cat/cat-nodeattrs/
|
||||
---
|
||||
|
||||
# CAT nodeattrs
|
||||
|
|
|
@ -5,6 +5,8 @@ parent: CAT API
|
|||
|
||||
nav_order: 40
|
||||
has_children: false
|
||||
redirect_from:
|
||||
- /opensearch/rest-api/cat/cat-nodes/
|
||||
---
|
||||
|
||||
# CAT nodes
|
||||
|
|
|
@ -5,6 +5,8 @@ parent: CAT API
|
|||
|
||||
nav_order: 45
|
||||
has_children: false
|
||||
redirect_from:
|
||||
- /opensearch/rest-api/cat/cat-pending-tasks/
|
||||
---
|
||||
|
||||
# CAT pending tasks
|
||||
|
|
|
@ -5,6 +5,8 @@ parent: CAT API
|
|||
|
||||
nav_order: 50
|
||||
has_children: false
|
||||
redirect_from:
|
||||
- /opensearch/rest-api/cat/cat-plugins/
|
||||
---
|
||||
|
||||
# CAT plugins
|
||||
|
|
|
@ -5,6 +5,8 @@ parent: CAT API
|
|||
|
||||
nav_order: 50
|
||||
has_children: false
|
||||
redirect_from:
|
||||
- /opensearch/rest-api/cat/cat-recovery/
|
||||
---
|
||||
|
||||
# CAT recovery
|
||||
|
|
|
@ -5,6 +5,8 @@ parent: CAT API
|
|||
|
||||
nav_order: 52
|
||||
has_children: false
|
||||
redirect_from:
|
||||
- /opensearch/rest-api/cat/cat-repositories/
|
||||
---
|
||||
|
||||
# CAT repositories
|
||||
|
|
|
@ -5,6 +5,8 @@ parent: CAT API
|
|||
|
||||
nav_order: 55
|
||||
has_children: false
|
||||
redirect_from:
|
||||
- /opensearch/rest-api/cat/cat-segments/
|
||||
---
|
||||
|
||||
# CAT segments
|
||||
|
@ -44,7 +46,7 @@ GET _cat/segments
|
|||
|
||||
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:
|
||||
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
|
||||
|
||||
Parameter | Type | Description
|
||||
:--- | :--- | :---
|
||||
|
|
|
@ -5,6 +5,8 @@ parent: CAT API
|
|||
|
||||
nav_order: 60
|
||||
has_children: false
|
||||
redirect_from:
|
||||
- /opensearch/rest-api/cat/cat-shards/
|
||||
---
|
||||
|
||||
# CAT shards
|
||||
|
@ -44,7 +46,7 @@ GET _cat/shards
|
|||
|
||||
All cat shards 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:
|
||||
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
|
||||
|
||||
Parameter | Type | Description
|
||||
:--- | :--- | :---
|
||||
|
|
|
@ -5,6 +5,8 @@ parent: CAT API
|
|||
|
||||
nav_order: 65
|
||||
has_children: false
|
||||
redirect_from:
|
||||
- /opensearch/rest-api/cat/cat-snapshots/
|
||||
---
|
||||
|
||||
# CAT snapshots
|
||||
|
|
|
@ -5,6 +5,8 @@ parent: CAT API
|
|||
|
||||
nav_order: 70
|
||||
has_children: false
|
||||
redirect_from:
|
||||
- /opensearch/rest-api/cat/cat-tasks/
|
||||
---
|
||||
|
||||
# CAT tasks
|
||||
|
@ -30,7 +32,7 @@ GET _cat/tasks
|
|||
|
||||
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:
|
||||
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
|
||||
|
||||
Parameter | Type | Description
|
||||
:--- | :--- | :---
|
||||
|
|
|
@ -5,13 +5,15 @@ parent: CAT API
|
|||
|
||||
nav_order: 70
|
||||
has_children: false
|
||||
redirect_from:
|
||||
- /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.
|
||||
The CAT templates operation lists the names, patterns, order numbers, and version numbers of index templates.
|
||||
|
||||
## Example
|
||||
|
||||
|
@ -38,7 +40,7 @@ GET _cat/templates
|
|||
|
||||
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:
|
||||
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
|
||||
|
||||
Parameter | Type | Description
|
||||
:--- | :--- | :---
|
||||
|
|
|
@ -4,6 +4,8 @@ title: CAT thread pool
|
|||
parent: CAT API
|
||||
nav_order: 75
|
||||
has_children: false
|
||||
redirect_from:
|
||||
- /opensearch/rest-api/cat/cat-thread-pool/
|
||||
---
|
||||
|
||||
# CAT thread pool
|
||||
|
@ -43,7 +45,7 @@ GET _cat/thread_pool
|
|||
|
||||
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:
|
||||
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
|
||||
|
||||
Parameter | Type | Description
|
||||
:--- | :--- | :---
|
||||
|
|
|
@ -5,7 +5,7 @@ nav_order: 10
|
|||
has_children: true
|
||||
redirect_from:
|
||||
- /opensearch/catapis/
|
||||
- /opensearch/rest-api/cat
|
||||
- /opensearch/rest-api/cat/index/
|
||||
---
|
||||
|
||||
# CAT API
|
||||
|
|
|
@ -3,13 +3,15 @@ layout: default
|
|||
title: Bulk
|
||||
parent: Document APIs
|
||||
nav_order: 20
|
||||
redirect_from:
|
||||
- /opensearch/rest-api/document-apis/bulk/
|
||||
---
|
||||
|
||||
# Bulk
|
||||
Introduced 1.0
|
||||
{: .label .label-purple }
|
||||
|
||||
The bulk operation lets you add, update, or delete many documents in a single request. Compared to individual OpenSearch indexing requests, the bulk operation has significant performance benefits. Whenever practical, we recommend batching indexing operations into bulk requests.
|
||||
The bulk operation lets you add, update, or delete multiple documents in a single request. Compared to individual OpenSearch indexing requests, the bulk operation has significant performance benefits. Whenever practical, we recommend batching indexing operations into bulk requests.
|
||||
|
||||
|
||||
## Example
|
||||
|
|
|
@ -7,6 +7,7 @@ has_toc: false
|
|||
redirect_from:
|
||||
- /clients/data-prepper/index/
|
||||
- /data-prepper/
|
||||
- /monitoring-plugins/trace/data-prepper/
|
||||
---
|
||||
|
||||
# Data Prepper
|
||||
|
|
|
@ -3,6 +3,8 @@ layout: default
|
|||
title: Configuring Data Prepper
|
||||
parent: Managing Data Prepper
|
||||
nav_order: 5
|
||||
redirect_from:
|
||||
- /clients/data-prepper/data-prepper-reference/
|
||||
---
|
||||
|
||||
# Configuring Data Prepper
|
||||
|
@ -21,8 +23,8 @@ serverPort | No | Integer | Port number to use for server APIs. Defaults to 4900
|
|||
metricRegistries | No | List | Metrics registries for publishing the generated metrics. Currently supports Prometheus and CloudWatch. Defaults to Prometheus.
|
||||
metricTags | No | Map | Key-value pairs as common metric tags to metric registries. The maximum number of pairs is three. Note that `serviceName` is a reserved tag key with `DataPrepper` as default tag value. Alternatively, administrators can set this value through the environment variable `DATAPREPPER_SERVICE_NAME`. If `serviceName` is defined in `metricTags`, that value overwrites those set through the above methods.
|
||||
authentication | No | Object | Authentication configuration. Valid option is `http_basic` with `username` and `password` properties. If not defined, the server does not perform authentication.
|
||||
processorShutdownTimeout | No | Duration | Time given to processors to clear any in-flight data and gracefully shutdown. Default is 30s.
|
||||
sinkShutdownTimeout | No | Duration | Time given to sinks to clear any in-flight data and gracefully shutdown. Default is 30s.
|
||||
processorShutdownTimeout | No | Duration | Time given to processors to clear any in-flight data and gracefully shut down. Default is 30s.
|
||||
sinkShutdownTimeout | No | Duration | Time given to sinks to clear any in-flight data and gracefully shut down. Default is 30s.
|
||||
peer_forwarder | No | Object | Peer forwarder configurations. See [Peer forwarder options](#peer-forwarder-options) for more details.
|
||||
|
||||
### Peer forwarder options
|
||||
|
|
Loading…
Reference in New Issue