Files
elasticsearch-js/docs/reference-slm-get_status.asciidoc
2024-12-05 14:46:52 -06:00

73 lines
3.8 KiB
Plaintext

[[reference-slm-get_status]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| 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.slm.getStatus]]
=== client.slm.getStatus
Retrieves the status of snapshot lifecycle management (SLM).
{ref}/slm-api-get-status.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(SlmGetStatusRequest, options?): Promise<SlmGetStatusResponse>
----
[discrete]
==== SlmGetStatusRequest
[pass]
++++
<pre>
++++
interface SlmGetStatusRequest extends <<RequestBase>> {
}
[pass]
++++
</pre>
++++
[discrete]
==== SlmGetStatusResponse
[pass]
++++
<pre>
++++
interface SlmGetStatusResponse {
operation_mode: <<LifecycleOperationMode>>
}
[pass]
++++
</pre>
++++