Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/reference/cat/alias.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ consumption, use the <<aliases,aliases API>>.
====

Retrieves the cluster's <<aliases,index aliases>>, including filter and routing
information. The API does not return data stream aliases.
information. The API does not return <<data-streams,data stream>> aliases.

[[cat-alias-api-request]]
==== {api-request-title}
Expand Down
5 changes: 3 additions & 2 deletions docs/reference/cat/allocation.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@
[IMPORTANT]
====
cat APIs are only intended for human consumption using the command line or {kib}
console. They are _not_ intended for use by applications.
console. They are _not_ intended for use by applications. For application
consumption, use the <<cluster-nodes-stats,node stats API>>.
====

Provides a snapshot of the number of shards allocated to each data node
Provides a snapshot of the number of shards <<modules-cluster,allocated>> to each data node
and their disk space.


Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cat/anomaly-detectors.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ consumption, use the
<<ml-get-job-stats,get anomaly detection job statistics API>>.
====

Returns configuration and usage information about {anomaly-jobs}.
Returns configuration and usage information about {ml-docs}/ml-ad-overview.html[{anomaly-jobs}].

[[cat-anomaly-detectors-request]]
==== {api-request-title}
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cat/datafeeds.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ console. They are _not_ intended for use by applications. For application
consumption, use the <<ml-get-datafeed-stats,get datafeed statistics API>>.
====

Returns configuration and usage information about {dfeeds}.
Returns configuration and usage information about {ml-docs}/ml-ad-run-jobs.html#ml-ad-datafeeds[{dfeeds}].

[[cat-datafeeds-request]]
==== {api-request-title}
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cat/dataframeanalytics.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ consumption, use the
<<get-dfanalytics-stats,get data frame analytics jobs statistics API>>.
====

Returns configuration and usage information about {dfanalytics-jobs}.
Returns configuration and usage information about {ml-docs}/ml-dfanalytics.html[{dfanalytics-jobs}].


[[cat-dfanalytics-request]]
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cat/indices.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ consumption, use the <<indices-get-index,get index API>>.
====

Returns high-level information about indices in a cluster, including backing
indices for data streams.
indices for <<data-streams,data streams>>.


[[cat-indices-api-request]]
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cat/master.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ console. They are _not_ intended for use by applications. For application
consumption, use the <<cluster-nodes-info,nodes info API>>.
====

Returns information about the master node, including the ID, bound IP address,
Returns information about the <<cluster-state-publishing,master node>, including the ID, bound IP address,
and name.


Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cat/nodeattrs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ console. They are _not_ intended for use by applications. For application
consumption, use the <<cluster-nodes-info,nodes info API>>.
====

Returns information about custom node attributes.
Returns information about <<shard-allocation-filtering,custom node attributes>>.

[[cat-nodeattrs-api-request]]
==== {api-request-title}
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cat/nodes.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ They are _not_ intended for use by applications.
For application consumption, use the <<cluster-nodes-info,nodes info API>>.
====

Returns information about a cluster's nodes.
Returns information about a <<modules-node,cluster's nodes>>.

[[cat-nodes-api-request]]
==== {api-request-title}
Expand Down
3 changes: 1 addition & 2 deletions docs/reference/cat/pending_tasks.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@ console. They are _not_ intended for use by applications. For application
consumption, use the <<cluster-pending,pending cluster tasks API>>.
====

Returns cluster-level changes that have not yet been executed, similar to the
<<cluster-pending, pending cluster tasks>> API.
Returns <<cluster-state-publishing,cluster-level changes>> that have not yet been executed.

[[cat-pending-tasks-api-request]]
==== {api-request-title}
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cat/plugins.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ console. They are _not_ intended for use by applications. For application
consumption, use the <<cluster-nodes-info,nodes info API>>.
====

Returns a list of plugins running on each node of a cluster.
Returns a list of <<modules-plugins,plugins>> running on each node of a cluster.


[[cat-plugins-api-request]]
Expand Down
5 changes: 2 additions & 3 deletions docs/reference/cat/recovery.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,9 @@ console. They are _not_ intended for use by applications. For application
consumption, use the <<indices-recovery,index recovery API>>.
====

Returns information about ongoing and completed shard recoveries,
similar to the <<indices-recovery, index recovery>> API.
Returns information about ongoing and completed <<shard-allocation-relocation-recovery,shard recoveries>>.

For data streams, the API returns information about the stream's backing
For <<data-streams,data streams>>, the API returns information about the stream's backing
indices.

[[cat-recovery-api-request]]
Expand Down
5 changes: 2 additions & 3 deletions docs/reference/cat/segments.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,9 @@ consumption, use the <<indices-segments,index segments API>>.
====

Returns low-level information about the https://lucene.apache.org/core/[Lucene]
segments in index shards, similar to the <<indices-segments, indices segments>>
API.
segments in index shards.

For data streams, the API returns information about the stream's backing
For <<data-streams,data streams>>, the API returns information about the stream's backing
indices.

[[cat-segments-api-request]]
Expand Down
11 changes: 7 additions & 4 deletions docs/reference/cat/shards.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,16 @@
====
cat APIs are only intended for human consumption using the command line or {kib}
console.
They are _not_ intended for use by applications.
They are _not_ intended for use by applications. For application
consumption, use the <<cluster-state,cluster state API>>.
====

The `shards` command is the detailed view of what nodes contain which shards.
It will tell you if it's a primary or replica, the number of docs, the bytes it takes on disk, and the node where it's located.
The `shards` command is the detailed view of all nodes' shard <<modules-cluster,allocation>>.
It will tell you if the shard is a primary or replica, the number of docs, the
bytes it takes on disk, the node where it's located, and if the shard is
currently <<shard-allocation-relocation-recovery,recovering>>.

For data streams, the API returns information about the stream's backing indices.
For <<data-streams,data streams>>, the API returns information about the stream's backing indices.

[[cat-shards-api-request]]
==== {api-request-title}
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cat/snapshots.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ consumption, use the <<get-snapshot-api,get snapshot API>>.
====

Returns information about the <<snapshot-restore,snapshots>> stored in one or
more repositories. A snapshot is a backup of an index or running {es} cluster.
more <<snapshots-register-repository,repositories>>. A snapshot is a backup of an index or running {es} cluster.


[[cat-snapshots-api-request]]
Expand Down
3 changes: 1 addition & 2 deletions docs/reference/cat/tasks.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ console. They are _not_ intended for use by applications. For application
consumption, use the <<tasks,task management API>>.
====

Returns information about tasks currently executing in the cluster,
similar to the <<tasks,task management>> API.
Returns information about tasks currently executing on <<modules-node,nodes>> in the <<modules-cluster,cluster>>.


[[cat-tasks-api-request]]
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cat/trainedmodel.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ console. They are _not_ intended for use by applications. For application
consumption, use the <<get-trained-models,get trained models API>>.
====

Returns configuration and usage information about {infer} trained models.
Returns configuration and usage information about {ml-docs}/ml-nlp-deploy-models.html[{infer} trained models].


[[cat-trained-model-request]]
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cat/transforms.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ console. They are _not_ intended for use by applications. For application
consumption, use the <<get-transform,get transforms API>>.
====

Returns configuration and usage information about {transforms}.
Returns configuration and usage information about <<transforms,{transforms}>>.

[[cat-transforms-api-request]]
==== {api-request-title}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<titleabbrev>Get {dfeed} statistics</titleabbrev>
++++

Retrieves usage information for {dfeeds}.
Retrieves usage information for {ml-docs}/ml-ad-run-jobs.html#ml-ad-datafeeds[{dfeeds}].

[[ml-get-datafeed-stats-request]]
== {api-request-title}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<titleabbrev>Get job statistics</titleabbrev>
++++

Retrieves usage information for {anomaly-jobs}.
Retrieves usage information for {ml-docs}/ml-ad-overview.html[{anomaly-jobs}].

[[ml-get-job-stats-request]]
== {api-request-title}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<titleabbrev>Get {dfanalytics-jobs} stats</titleabbrev>
++++

Retrieves usage information for {dfanalytics-jobs}.
Retrieves usage information for {ml-docs}/ml-dfanalytics.html[{dfanalytics-jobs}].


[[ml-get-dfanalytics-stats-request]]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<titleabbrev>Get trained models</titleabbrev>
++++

Retrieves configuration information for a trained model.
Retrieves configuration information about {ml-docs}/ml-nlp-deploy-models.html[{infer} trained models].


[[ml-get-trained-models-request]]
Expand Down