Compact and aligned text (CAT) Client

class opensearchpy.client.cat.CatClient(client)[source]

Bases: NamespacedClient

Parameters:: client (Any) –

aliases(name=None, params=None, headers=None)[source]

Shows information about currently configured aliases to indexes including filter and routing info.

Parameters:

name (Any) – A comma-separated list of aliases to retrieve. Supports wildcards (*). To retrieve all aliases, omit this parameter or use * or _all.
error_trace – Whether to include the stack trace of returned errors. Default is false.
expand_wildcards – Whether to expand wildcard expression to concrete indexes that are open, closed or both.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
format – A short version of the Accept header (for example, json, yaml).
h – Comma-separated list of column names to display.
help – Return help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
local – Return local information, do not retrieve the state from cluster-manager node. Default is false.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – Comma-separated list of column names or column aliases to sort by.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
v – Verbose mode. Display column headers. Default is false.
name –
params (Any) –
headers (Any) –

Return type:

Any

all_pit_segments(params=None, headers=None)[source]

Lists all active point-in-time segments.

Parameters:

bytes – The unit in which to display byte values. Valid choices are b, g, gb, k, kb, m, mb, p, pb, t, tb.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
format – A short version of the Accept header (for example, json, yaml).
h – Comma-separated list of column names to display.
help – Return help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – Comma-separated list of column names or column aliases to sort by.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
v – Verbose mode. Display column headers. Default is false.
params (Any) –
headers (Any) –

Return type:

Any

allocation(node_id=None, params=None, headers=None)[source]

Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.

Parameters:

node_id (Any) – Comma-separated list of node identifiers or names used to limit the returned information.
bytes – The unit used to display byte values. Valid choices are b, g, gb, k, kb, m, mb, p, pb, t, tb.
cluster_manager_timeout – Operation timeout for connection to cluster-manager node.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
format – A short version of the Accept header (for example, json, yaml).
h – Comma-separated list of column names to display.
help – Return help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
local – Return local information, do not retrieve the state from cluster-manager node. Default is false.
(Deprecated (master_timeout) – To promote inclusive language, use cluster_manager_timeout instead.): Operation timeout for connection to cluster-manager node.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – Comma-separated list of column names or column aliases to sort by.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
v – Verbose mode. Display column headers. Default is false.
node_id –
params (Any) –
headers (Any) –

Return type:

Any

cluster_manager(params=None, headers=None)[source]

Returns information about the cluster-manager node.

Parameters:

cluster_manager_timeout – Operation timeout for connection to cluster-manager node.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
format – A short version of the Accept header (for example, json, yaml).
h – Comma-separated list of column names to display.
help – Return help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
local – Return local information, do not retrieve the state from cluster-manager node. Default is false.
(Deprecated (master_timeout) – To promote inclusive language, use cluster_manager_timeout instead.): Operation timeout for connection to cluster-manager node.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – Comma-separated list of column names or column aliases to sort by.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
v – Verbose mode. Display column headers. Default is false.
params (Any) –
headers (Any) –

Return type:

Any

count(index=None, params=None, headers=None)[source]

Provides quick access to the document count of the entire cluster, or individual indexes.

Parameters:

index (Any) – Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
format – A short version of the Accept header (for example, json, yaml).
h – Comma-separated list of column names to display.
help – Return help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – Comma-separated list of column names or column aliases to sort by.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
v – Verbose mode. Display column headers. Default is false.
index –
params (Any) –
headers (Any) –

Return type:

Any

fielddata(fields=None, params=None, headers=None)[source]

Shows how much heap memory is currently being used by field data on every data node in the cluster.

Parameters:

fields (Any) – Comma-separated list of fields used to limit returned information.
bytes – The unit used to display byte values. Valid choices are b, g, gb, k, kb, m, mb, p, pb, t, tb.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
format – A short version of the Accept header (for example, json, yaml).
h – Comma-separated list of column names to display.
help – Return help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – Comma-separated list of column names or column aliases to sort by.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
v – Verbose mode. Display column headers. Default is false.
fields –
params (Any) –
headers (Any) –

Return type:

Any

health(params=None, headers=None)[source]

Returns a concise representation of the cluster health.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
format – A short version of the Accept header (for example, json, yaml).
h – Comma-separated list of column names to display.
help – Return help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – Comma-separated list of column names or column aliases to sort by.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
time – The unit used to display time values. Valid choices are d, h, m, micros, ms, nanos, s.
ts – If true, returns HH:MM:SS and Unix epoch timestamps. Default is True.
v – Verbose mode. Display column headers. Default is false.
params (Any) –
headers (Any) –

Return type:

Any

help(params=None, headers=None)[source]

Returns help for the Cat APIs.

Parameters:

error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
params (Any) –
headers (Any) –

Return type:

Any

indices(index=None, params=None, headers=None)[source]

Returns information about indexes: number of primaries and replicas, document counts, disk size, …

Parameters:

index (Any) – Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
bytes – The unit used to display byte values. Valid choices are b, g, gb, k, kb, m, mb, p, pb, t, tb.
cluster_manager_timeout – Operation timeout for connection to cluster-manager node.
error_trace – Whether to include the stack trace of returned errors. Default is false.
expand_wildcards – The type of index that wildcard patterns can match.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
format – A short version of the Accept header (for example, json, yaml).
h – Comma-separated list of column names to display.
health – The health status used to limit returned indexes. By default, the response includes indexes of any health status. Valid choices are green, red, yellow.
help – Return help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
include_unloaded_segments – If true, the response includes information from segments that are not loaded into memory. Default is false.
local – Return local information, do not retrieve the state from cluster-manager node. Default is false.
(Deprecated (master_timeout) – To promote inclusive language, use cluster_manager_timeout instead.): Operation timeout for connection to cluster-manager node.
pretty – Whether to pretty format the returned JSON response. Default is false.
pri – If true, the response only includes information from primary shards. Default is false.
s – Comma-separated list of column names or column aliases to sort by.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
time – The unit used to display time values. Valid choices are d, h, m, micros, ms, nanos, s.
v – Verbose mode. Display column headers. Default is false.
index –
params (Any) –
headers (Any) –

Return type:

Any

master(params=None, headers=None)[source]

Returns information about the cluster-manager node.

Parameters:

cluster_manager_timeout – Operation timeout for connection to cluster-manager node.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
format – A short version of the Accept header (for example, json, yaml).
h – Comma-separated list of column names to display.
help – Return help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
local – Return local information, do not retrieve the state from cluster-manager node. Default is false.
(Deprecated (master_timeout) – To promote inclusive language, use cluster_manager_timeout instead.): Operation timeout for connection to cluster-manager node.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – Comma-separated list of column names or column aliases to sort by.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
v – Verbose mode. Display column headers. Default is false.
params (Any) –
headers (Any) –

Return type:

Any

nodeattrs(params=None, headers=None)[source]

Returns information about custom node attributes.

Parameters:

cluster_manager_timeout – Operation timeout for connection to cluster-manager node.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
format – A short version of the Accept header (for example, json, yaml).
h – Comma-separated list of column names to display.
help – Return help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
local – Return local information, do not retrieve the state from cluster-manager node. Default is false.
(Deprecated (master_timeout) – To promote inclusive language, use cluster_manager_timeout instead.): Operation timeout for connection to cluster-manager node.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – Comma-separated list of column names or column aliases to sort by.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
v – Verbose mode. Display column headers. Default is false.
params (Any) –
headers (Any) –

Return type:

Any

nodes(params=None, headers=None)[source]

Returns basic statistics about performance of cluster nodes.

Parameters:

bytes – The unit used to display byte values. Valid choices are b, g, gb, k, kb, m, mb, p, pb, t, tb.
cluster_manager_timeout – Operation timeout for connection to cluster-manager node.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
format – A short version of the Accept header (for example, json, yaml).
full_id – If true, return the full node ID. If false, return the shortened node ID. Default is false.
h – Comma-separated list of column names to display.
help – Return help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
(Deprecated (master_timeout) – This parameter does not cause this API to act locally.): Return local information, do not retrieve the state from cluster-manager node. Default is false.
(Deprecated – To promote inclusive language, use cluster_manager_timeout instead.): Operation timeout for connection to cluster-manager node.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – Comma-separated list of column names or column aliases to sort by.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
time – The unit in which to display time values. Valid choices are d, h, m, micros, ms, nanos, s.
v – Verbose mode. Display column headers. Default is false.
params (Any) –
headers (Any) –

Return type:

Any

pending_tasks(params=None, headers=None)[source]

Returns a concise representation of the cluster pending tasks.

Parameters:

cluster_manager_timeout – Operation timeout for connection to cluster-manager node.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
format – A short version of the Accept header (for example, json, yaml).
h – Comma-separated list of column names to display.
help – Return help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
local – Return local information, do not retrieve the state from cluster-manager node. Default is false.
(Deprecated (master_timeout) – To promote inclusive language, use cluster_manager_timeout instead.): Operation timeout for connection to cluster-manager node.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – Comma-separated list of column names or column aliases to sort by.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
time – The unit in which to display time values. Valid choices are d, h, m, micros, ms, nanos, s.
v – Verbose mode. Display column headers. Default is false.
params (Any) –
headers (Any) –

Return type:

Any

pit_segments(body=None, params=None, headers=None)[source]

List segments for one or several PITs.

Parameters:

bytes – The unit in which to display byte values. Valid choices are b, g, gb, k, kb, m, mb, p, pb, t, tb.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
format – A short version of the Accept header (for example, json, yaml).
h – Comma-separated list of column names to display.
help – Return help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – Comma-separated list of column names or column aliases to sort by.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
v – Verbose mode. Display column headers. Default is false.
body (Any) –
params (Any) –
headers (Any) –

Return type:

Any

plugins(params=None, headers=None)[source]

Returns information about installed plugins across nodes node.

Parameters:

cluster_manager_timeout – Operation timeout for connection to cluster-manager node.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
format – A short version of the Accept header (for example, json, yaml).
h – Comma-separated list of column names to display.
help – Return help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
local – Return local information, do not retrieve the state from cluster-manager node. Default is false.
(Deprecated (master_timeout) – To promote inclusive language, use cluster_manager_timeout instead.): Operation timeout for connection to cluster-manager node.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – Comma-separated list of column names or column aliases to sort by.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
v – Verbose mode. Display column headers. Default is false.
params (Any) –
headers (Any) –

Return type:

Any

recovery(index=None, params=None, headers=None)[source]

Returns information about index shard recoveries, both on-going completed.

Parameters:

index (Any) – Comma-separated list or wildcard expression of index names to limit the returned information.
active_only – If true, the response only includes ongoing shard recoveries. Default is false.
bytes – The unit used to display byte values. Valid choices are b, g, gb, k, kb, m, mb, p, pb, t, tb.
detailed – If true, the response includes detailed information about shard recoveries. Default is false.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
format – A short version of the Accept header (for example, json, yaml).
h – Comma-separated list of column names to display.
help – Return help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – Comma-separated list of column names or column aliases to sort by.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
time – The unit in which to display time values. Valid choices are d, h, m, micros, ms, nanos, s.
v – Verbose mode. Display column headers. Default is false.
index –
params (Any) –
headers (Any) –

Return type:

Any

repositories(params=None, headers=None)[source]

Returns information about snapshot repositories registered in the cluster.

Parameters:

cluster_manager_timeout – Operation timeout for connection to cluster-manager node.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
format – A short version of the Accept header (for example, json, yaml).
h – Comma-separated list of column names to display.
help – Return help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
local – Return local information, do not retrieve the state from cluster-manager node. Default is false.
(Deprecated (master_timeout) – To promote inclusive language, use cluster_manager_timeout instead.): Operation timeout for connection to cluster-manager node.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – Comma-separated list of column names or column aliases to sort by.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
v – Verbose mode. Display column headers. Default is false.
params (Any) –
headers (Any) –

Return type:

Any

segment_replication(index=None, params=None, headers=None)[source]

Returns information about both on-going and latest completed Segment Replication events.

Parameters:

index (Any) – Comma-separated list or wildcard expression of index names to limit the returned information.
active_only – If true, the response only includes ongoing segment replication events. Default is false.
allow_no_indices – Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes _all string or when no indexes have been specified).
bytes – The unit in which to display byte values. Valid choices are b, g, gb, k, kb, m, mb, p, pb, t, tb.
completed_only – If true, the response only includes latest completed segment replication events. Default is false.
detailed – If true, the response includes detailed information about segment replications. Default is false.
error_trace – Whether to include the stack trace of returned errors. Default is false.
expand_wildcards – Whether to expand wildcard expression to concrete indexes that are open, closed or both.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
format – A short version of the Accept header (for example, json, yaml).
h – Comma-separated list of column names to display.
help – Return help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
ignore_throttled – Whether specified concrete, expanded or aliased indexes should be ignored when throttled.
ignore_unavailable – Whether specified concrete indexes should be ignored when unavailable (missing or closed).
pretty – Whether to pretty format the returned JSON response. Default is false.
s – Comma-separated list of column names or column aliases to sort by.
shards – Comma-separated list of shards to display.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
time – The unit in which to display time values. Valid choices are d, h, m, micros, ms, nanos, s.
timeout – Operation timeout.
v – Verbose mode. Display column headers. Default is false.
index –
params (Any) –
headers (Any) –

Return type:

Any

segments(index=None, params=None, headers=None)[source]

Provides low-level information about the segments in the shards of an index.

Parameters:

index (Any) – A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
bytes – The unit used to display byte values. Valid choices are b, g, gb, k, kb, m, mb, p, pb, t, tb.
cluster_manager_timeout – Operation timeout for connection to cluster-manager node.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
format – A short version of the Accept header (for example, json, yaml).
h – Comma-separated list of column names to display.
help – Return help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
(Deprecated (master_timeout) – To promote inclusive language, use cluster_manager_timeout instead.): Operation timeout for connection to cluster-manager node.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – Comma-separated list of column names or column aliases to sort by.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
v – Verbose mode. Display column headers. Default is false.
index –
params (Any) –
headers (Any) –

Return type:

Any

shards(index=None, params=None, headers=None)[source]

Provides a detailed view of shard allocation on nodes.

Parameters:

index (Any) – A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
bytes – The unit used to display byte values. Valid choices are b, g, gb, k, kb, m, mb, p, pb, t, tb.
cluster_manager_timeout – Operation timeout for connection to cluster-manager node.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
format – A short version of the Accept header (for example, json, yaml).
h – Comma-separated list of column names to display.
help – Return help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
local – Return local information, do not retrieve the state from cluster-manager node. Default is false.
(Deprecated (master_timeout) – To promote inclusive language, use cluster_manager_timeout instead.): Operation timeout for connection to cluster-manager node.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – Comma-separated list of column names or column aliases to sort by.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
time – The unit in which to display time values. Valid choices are d, h, m, micros, ms, nanos, s.
v – Verbose mode. Display column headers. Default is false.
index –
params (Any) –
headers (Any) –

Return type:

Any

snapshots(repository=None, params=None, headers=None)[source]

Returns all snapshots in a specific repository.

Parameters:

repository (Any) – A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. _all returns all repositories. If any repository fails during the request, OpenSearch returns an error.
cluster_manager_timeout – Operation timeout for connection to cluster-manager node.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
format – A short version of the Accept header (for example, json, yaml).
h – Comma-separated list of column names to display.
help – Return help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
ignore_unavailable – If true, the response does not include information from unavailable snapshots. Default is false.
(Deprecated (master_timeout) – To promote inclusive language, use cluster_manager_timeout instead.): Operation timeout for connection to cluster-manager node.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – Comma-separated list of column names or column aliases to sort by.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
time – The unit in which to display time values. Valid choices are d, h, m, micros, ms, nanos, s.
v – Verbose mode. Display column headers. Default is false.
repository –
params (Any) –
headers (Any) –

Return type:

Any

tasks(params=None, headers=None)[source]

Returns information about the tasks currently executing on one or more nodes in the cluster.

Parameters:

actions – The task action names, which are used to limit the response.
detailed – If true, the response includes detailed information about shard recoveries. Default is false.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
format – A short version of the Accept header (for example, json, yaml).
h – Comma-separated list of column names to display.
help – Return help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
nodes – Comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you’re connecting to, leave empty to get information from all nodes.
parent_task_id – The parent task identifier, which is used to limit the response.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – Comma-separated list of column names or column aliases to sort by.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
time – The unit in which to display time values. Valid choices are d, h, m, micros, ms, nanos, s.
v – Verbose mode. Display column headers. Default is false.
params (Any) –
headers (Any) –

Return type:

Any

templates(name=None, params=None, headers=None)[source]

Returns information about existing templates.

Parameters:

name (Any) – The name of the template to return. Accepts wildcard expressions. If omitted, all templates are returned.
cluster_manager_timeout – Operation timeout for connection to cluster-manager node.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
format – A short version of the Accept header (for example, json, yaml).
h – Comma-separated list of column names to display.
help – Return help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
local – Return local information, do not retrieve the state from cluster-manager node. Default is false.
(Deprecated (master_timeout) – To promote inclusive language, use cluster_manager_timeout instead.): Operation timeout for connection to cluster-manager node.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – Comma-separated list of column names or column aliases to sort by.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
v – Verbose mode. Display column headers. Default is false.
name –
params (Any) –
headers (Any) –

Return type:

Any

thread_pool(thread_pool_patterns=None, params=None, headers=None)[source]

Returns cluster-wide thread pool statistics per node. By default the active, queue and rejected statistics are returned for all thread pools.

Parameters:

thread_pool_patterns (Any) – A comma-separated list of thread pool names used to limit the request. Accepts wildcard expressions.
cluster_manager_timeout – Operation timeout for connection to cluster-manager node.
error_trace – Whether to include the stack trace of returned errors. Default is false.
filter_path – Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with “-“.
format – A short version of the Accept header (for example, json, yaml).
h – Comma-separated list of column names to display.
help – Return help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
local – Return local information, do not retrieve the state from cluster-manager node. Default is false.
(Deprecated (master_timeout) – To promote inclusive language, use cluster_manager_timeout instead.): Operation timeout for connection to cluster-manager node.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – Comma-separated list of column names or column aliases to sort by.
size – The multiplier in which to display values.
source – The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
v – Verbose mode. Display column headers. Default is false.
thread_pool_patterns –
params (Any) –
headers (Any) –

Return type:

Any