X-Pack

class elasticsearch.client.XPackClient

To use this client, access client.x_pack from an Elasticsearch client. For example:

from elasticsearch import Elasticsearch

# Create the client instance
client = Elasticsearch(...)
# Use the x_pack client
client.x_pack.<method>(...)

info(*, accept_enterprise=None, categories=None, error_trace=None, filter_path=None, human=None, pretty=None)

获取信息。 该API提供的信息包括：

• 构建信息，包括构建编号和时间戳。
• 当前安装许可证的许可信息。
• 当前许可证下已启用和可用功能的特性信息。

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-info

Parameters:

• accept_enterprise (bool | None) – 如果使用此参数，必须设置为true

• categories (Sequence[str | Literal['build', 'features', 'license']] | None) – 要包含在响应中的信息类别逗号分隔列表。例如 build,license,features。

• error_trace (bool | None)

• filter_path (str | Sequence[str] | None)

• human (bool | None)

• pretty (bool | None)

Return type:

ObjectApiResponse[Any]

usage(*, error_trace=None, filter_path=None, human=None, master_timeout=None, pretty=None)

获取使用情况信息。 获取当前许可证下已启用和可用功能的相关信息。 该API还提供一些使用统计信息。

https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-xpack

Parameters:

• master_timeout (str | Literal[-1] | ~typing.Literal[0] | None) – 等待连接主节点的时间段。 如果在超时前未收到响应，请求将失败并返回错误。 若要表示请求永不超时，请设置为 -1。

• error_trace (bool | None)

• filter_path (str | Sequence[str] | None)

• human (bool | None)

• pretty (bool | None)

Return type:

ObjectApiResponse[Any]