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>

2022-10-31 09:21:32 -07:00

1.1 KiB

Raw Blame History

layout, title, parent, nav_order, has_children

layout	title	parent	nav_order	has_children
default	CAT snapshots	CAT API	65	false

CAT snapshots

Introduced 1.0 {: .label .label-purple }

The CAT snapshots operation lists all snapshots for a repository.

Example

GET _cat/snapshots?v

Path and HTTP methods

GET _cat/snapshots

URL parameters

All CAT snapshots URL parameters are optional.

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

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.
time	Time	Specify the units for time. For example, `5d` or `7h`. For more information, see Supported units.

Response

index | shard | prirep | state   | docs | store | ip |       | node
plugins | 0   |   p    | STARTED |   0  |  208b | 172.18.0.4 | odfe-node1
plugins | 0   |   r    | STARTED |   0  |  208b | 172.18.0.3 |  odfe-node2

1.1 KiB Raw Blame History