62 lines
4.1 KiB
Plaintext
62 lines
4.1 KiB
Plaintext
[[reference-cat-snapshots]]
|
|
|
|
////////
|
|
===========================================================================================================================
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
|
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
|
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
|
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
|
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
|
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
|
|| ||
|
|
|| ||
|
|
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|
|
|| You should update the script that does the generation, which can be found in: ||
|
|
|| https://github.com/elastic/elastic-client-generator-js ||
|
|
|| ||
|
|
|| You can run the script with the following command: ||
|
|
|| npm run elasticsearch -- --version <version> ||
|
|
|| ||
|
|
|| ||
|
|
|| ||
|
|
===========================================================================================================================
|
|
////////
|
|
|
|
[discrete]
|
|
=== client.cat.snapshots
|
|
|
|
Returns information about the snapshots stored in one or more repositories. A snapshot is a backup of an index or running Elasticsearch cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.
|
|
|
|
{ref}/cat-snapshots.html[{es} documentation]
|
|
|
|
[discrete]
|
|
==== Function signature
|
|
|
|
[source,ts]
|
|
----
|
|
(CatSnapshotsRequest, options?): Promise<CatSnapshotsResponse>
|
|
----
|
|
|
|
[discrete]
|
|
===== `CatSnapshotsRequest`
|
|
|
|
[source,ts]
|
|
----
|
|
interface CatSnapshotsRequest extends CatCatRequestBase {
|
|
repository?: <<Names>>
|
|
ignore_unavailable?: boolean
|
|
}
|
|
----
|
|
|
|
[discrete]
|
|
===== `CatSnapshotsResponse`
|
|
|
|
[source,ts]
|
|
----
|
|
type CatSnapshotsResponse = CatSnapshotsSnapshotsRecord[]
|
|
----
|
|
|