快照生命周期管理（SLM）
- class elasticsearch.client.SlmClient
To use this client, access
client.slmfrom anElasticsearchclient. For example:from elasticsearch import Elasticsearch # Create the client instance client = Elasticsearch(...) # Use the slm client client.slm.<method>(...)
- delete_lifecycle(*, policy_id, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None, timeout=None)
删除策略。 删除快照生命周期策略定义。 此操作将阻止未来任何快照的创建，但不会取消进行中的快照或删除已创建的快照。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-delete-lifecycle
- Parameters:
- Return type:
- execute_lifecycle(*, policy_id, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None, timeout=None)
执行策略。 立即根据快照生命周期策略创建快照，而无需等待计划时间。 快照策略通常按其计划执行，但在执行升级或其他维护前，您可能需要手动运行策略。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-execute-lifecycle
- Parameters:
- Return type:
- execute_retention(*, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None, timeout=None)
执行保留策略。 手动应用保留策略以立即删除根据快照生命周期策略保留规则已过期的快照。 保留策略通常按其计划执行。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-execute-retention
- get_lifecycle(*, policy_id=None, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None, timeout=None)
获取策略信息。 获取快照生命周期策略定义及最近快照尝试的相关信息。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-get-lifecycle
- Parameters:
policy_id (str | Sequence[str] | None) – 要检索的快照生命周期策略的逗号分隔列表
master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – 等待连接主节点的时间。 如果在超时前未收到响应，请求将失败 并返回错误。
timeout (str | Literal[-1] | ~typing.Literal[0] | None) – 等待响应的时间。如果在超时前 未收到响应，请求将失败并返回错误。
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- get_stats(*, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None, timeout=None)
获取快照生命周期管理统计信息。 获取关于快照生命周期管理所采取操作的全局及策略级别统计信息。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-get-stats
- get_status(*, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None, timeout=None)
获取快照生命周期管理状态。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-get-status
- Parameters:
master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – 等待连接到主节点的时间段。 如果在超时到期前未收到响应，请求将失败 并返回错误。若要表示请求永不超时， 请将其设置为 -1。
timeout (str | Literal[-1] | ~typing.Literal[0] | None) – 等待响应的时长。如果在超时到期前 未收到响应，请求将失败并返回错误。若要表示 请求永不超时，请将其设置为 -1。
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- put_lifecycle(*, policy_id, config=None, error_trace=None, filter_path=None, human=None, master_timeout=None, name=None, pretty=None, repository=None, retention=None, schedule=None, timeout=None, body=None)
创建或更新策略。 创建或更新快照生命周期策略。 如果策略已存在，此请求会增加策略版本号。 只保留策略的最新版本。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-put-lifecycle
- Parameters:
policy_id (str) – 要创建或更新的快照生命周期策略标识符。
master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – 等待连接到主节点的时间段。 如果在超时到期前未收到响应，请求将失败 并返回错误。若要表示请求永不超时， 请将其设置为 -1。
name (str | None) – 自动分配给该策略创建的每个快照的名称。 支持日期运算。为防止快照名称冲突，系统会自动 在每个快照名称后附加UUID。
repository (str | None) – 用于存储该策略创建的快照的仓库。 此仓库必须在策略创建前已存在。您可以使用 快照仓库API创建仓库。
retention (Mapping[str, Any] | None) – 用于保留和删除该策略创建的快照的保留规则。
schedule (str | None) – 策略创建快照的周期性或绝对时间计划。 SLM会立即应用计划变更。
timeout (str | Literal[-1] | ~typing.Literal[0] | None) – 等待响应的时长。如果在超时到期前 未收到响应，请求将失败并返回错误。若要表示 请求永不超时，请将其设置为 -1。
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- start(*, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None, timeout=None)
启动快照生命周期管理。 快照生命周期管理(SLM)在集群形成时会自动启动。 只有在使用停止SLM API停止后，才需要手动启动SLM。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-start
- Parameters:
master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – 等待连接到主节点的时间段。 如果在超时到期前未收到响应，请求将失败 并返回错误。若要表示请求永不超时， 请将其设置为 -1。
timeout (str | Literal[-1] | ~typing.Literal[0] | None) – 等待响应的时长。如果在超时到期前 未收到响应，请求将失败并返回错误。若要表示 请求永不超时，请将其设置为 -1。
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type:
- stop(*, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None, timeout=None)
停止快照生命周期管理。 停止所有快照生命周期管理(SLM)操作和SLM插件。 当您对集群执行维护并需要防止SLM对数据流或索引执行任何操作时，此API非常有用。 停止SLM不会停止任何正在进行的快照。 即使SLM已停止，您仍可以使用运行快照生命周期策略API手动触发快照。
API在请求被确认后会立即返回响应，但插件可能会继续运行直到进行中的操作完成并能安全停止。 使用获取快照生命周期管理状态API可查看SLM是否正在运行。
https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-slm-stop
- Parameters:
master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – 等待连接到主节点的时间段。 如果在超时到期前未收到响应，请求将失败 并返回错误。若要表示请求永不超时， 请将其设置为 -1。
timeout (str | Literal[-1] | ~typing.Literal[0] | None) – 等待响应的时长。如果在超时到期前 未收到响应，请求将失败并返回错误。若要表示 请求永不超时，请将其设置为 -1。
error_trace (bool | None)
human (bool | None)
pretty (bool | None)
- Return type: