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 aliases currently configured to indexes, including filter and routing information.

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 – Specifies the type of index that wildcard expressions can match. Supports comma-separated values. Valid choices are all, closed, hidden, none, open.
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, such as json or yaml.
h – A comma-separated list of column names to display.
help – Returns help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
local – Whether to return information from the local node only instead of from the cluster manager node. Default is false.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – A 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 – Enables verbose mode, which displays column headers. Default is false.
name –
params (Any) –
headers (Any) –

Return type:

Any

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

Lists all active CAT point-in-time segments.

Parameters:

bytes – The units used to display byte values. Valid choices are b, kb, k, mb, m, gb, g, tb, t, pb, p.
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, such as json or yaml.
h – A comma-separated list of column names to display.
help – Returns 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 – A 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 – Enables verbose mode, which displays 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) – A comma-separated list of node IDs or names used to limit the returned information.
bytes – The units used to display byte values. Valid choices are b, kb, k, mb, m, gb, g, tb, t, pb, p.
cluster_manager_timeout – A timeout for connection to the 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 HTTP Accept header, such as json or yaml.
h – A comma-separated list of column names to display.
help – Returns help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
local – Returns local information but does not retrieve the state from cluster-manager node. Default is false.
(Deprecated (master_timeout) – To promote inclusive language, use cluster_manager_timeout instead.): A timeout for connection to the cluster manager node.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – A 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 – Enables verbose mode, which displays 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 – A timeout for connection to the 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 HTTP Accept header, such as json or yaml.
h – A comma-separated list of column names to display.
help – Returns help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
local – Returns local information but does not retrieve the state from the cluster manager node. Default is false.
(Deprecated (master_timeout) – To promote inclusive language, use cluster_manager_timeout instead.): A timeout for connection to the cluster manager node.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – A 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 – Enables verbose mode, which displays 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 of an individual 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.
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, such as json or yaml.
h – A comma-separated list of column names to display.
help – Returns 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 – A 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 – Enables verbose mode, which displays 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) – A comma-separated list of fields used to limit the amount of returned information.
bytes – The units used to display byte values. Valid choices are b, kb, k, mb, m, gb, g, tb, t, pb, p.
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, such as json or yaml.
h – A comma-separated list of column names to display.
help – Returns 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 – A 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 – Enables verbose mode, which displays 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, such as json or yaml.
h – A comma-separated list of column names to display.
help – Returns 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 – A 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 nanos, micros, ms, s, m, h, d.
ts – When true, returns HH:MM:SS and Unix epoch timestamps. Default is True.
v – Enables verbose mode, which displays 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]

Lists information related to indexes, that is, how much disk space they are using, how many shards they have, their health status, and so on.

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 units used to display byte values. Valid choices are b, kb, k, mb, m, gb, g, tb, t, pb, p.
cluster_manager_timeout – The amount of time allowed to establish a connection to the cluster manager node.
error_trace – Whether to include the stack trace of returned errors. Default is false.
expand_wildcards – Specifies the type of index that wildcard expressions can match. Supports comma-separated values. Valid choices are all, closed, hidden, none, open.
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, such as json or yaml.
h – A comma-separated list of column names to display.
health – Limits indexes based on their health status. Supported values are green, yellow, and red. Valid choices are green, yellow, red.
help – Returns help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
include_unloaded_segments – Whether to include information from segments not loaded into memory. Default is false.
local – Returns local information but does not retrieve the state from the cluster manager node. Default is false.
(Deprecated (master_timeout) – To promote inclusive language, use cluster_manager_timeout instead.): The amount of time allowed to establish a connection to the cluster manager node.
pretty – Whether to pretty format the returned JSON response. Default is false.
pri – When true, returns information only from the primary shards. Default is false.
s – A 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 – Specifies the time units. Valid choices are nanos, micros, ms, s, m, h, d.
v – Enables verbose mode, which displays 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 – The amount of time allowed to establish a connection to the 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, such as json or yaml.
h – A comma-separated list of column names to display.
help – Returns help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
local – Returns local information but does not retrieve the state from the cluster manager node. Default is false.
(Deprecated (master_timeout) – To promote inclusive language, use cluster_manager_timeout instead.): The amount of time allowed to establish a connection to the cluster manager node.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – A 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 – Enables verbose mode, which displays 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 – The amount of time allowed to establish a connection to the 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, such as json or yaml.
h – A comma-separated list of column names to display.
help – Returns help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
local – Returns local information but does not retrieve the state from the cluster manager node. Default is false.
(Deprecated (master_timeout) – To promote inclusive language, use cluster_manager_timeout instead.): The amount of time allowed to establish a connection to the cluster manager node.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – A 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 – Enables verbose mode, which displays column headers. Default is false.
params (Any) –
headers (Any) –

Return type:

Any

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

Returns basic statistics about the performance of cluster nodes.

Parameters:

bytes – The units used to display byte values. Valid choices are b, kb, k, mb, m, gb, g, tb, t, pb, p.
cluster_manager_timeout – The amount of time allowed to establish a connection to the 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, such as json or yaml.
full_id – When true, returns the full node ID. When false, returns the shortened node ID.
h – A comma-separated list of column names to display.
help – Returns 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.): Returns local information but does not retrieve the state from the cluster manager node. Default is false.
(Deprecated – To promote inclusive language, use cluster_manager_timeout instead.): The amount of time allowed to establish a connection to the cluster manager node.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – A 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 – Specifies the time units, for example, 5d or 7h. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/). Valid choices are nanos, micros, ms, s, m, h, d.
v – Enables verbose mode, which displays 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’s pending tasks.

Parameters:

cluster_manager_timeout – The amount of time allowed to establish a connection to the 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, such as json or yaml.
h – A comma-separated list of column names to display.
help – Returns help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
local – Returns local information but does not retrieve the state from the cluster manager node. Default is false.
(Deprecated (master_timeout) – To promote inclusive language, use cluster_manager_timeout instead.): The amount of time allowed to establish a connection to the cluster manager node.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – A 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 – Specifies the time units, for example, 5d or 7h. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/). Valid choices are nanos, micros, ms, s, m, h, d.
v – Enables verbose mode, which displays column headers. Default is false.
params (Any) –
headers (Any) –

Return type:

Any

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

Lists one or several CAT point-in-time segments.

Parameters:

bytes – The units used to display byte values. Valid choices are b, kb, k, mb, m, gb, g, tb, t, pb, p.
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, such as json or yaml.
h – A comma-separated list of column names to display.
help – Returns 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 – A 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 – Enables verbose mode, which displays column headers. Default is false.
body (Any) –
params (Any) –
headers (Any) –

Return type:

Any

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

Returns information about the names, components, and versions of the installed plugins.

Parameters:

cluster_manager_timeout – The amount of time allowed to establish a connection to the 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, such as json or yaml.
h – A comma-separated list of column names to display.
help – Returns help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
local – Returns local information but does not retrieve the state from the cluster manager node. Default is false.
(Deprecated (master_timeout) – To promote inclusive language, use cluster_manager_timeout instead.): The amount of time allowed to establish a connection to the cluster manager node.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – A 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 – Enables verbose mode, which displays column headers. Default is false.
params (Any) –
headers (Any) –

Return type:

Any

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

Returns all completed and ongoing index and shard recoveries.

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.
active_only – If true, the response only includes ongoing shard recoveries. Default is false.
bytes – The units used to display byte values. Valid choices are b, kb, k, mb, m, gb, g, tb, t, pb, p.
detailed – When true, 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, such as json or yaml.
h – A comma-separated list of column names to display.
help – Returns 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 – A 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 – Specifies the time units, for example, 5d or 7h. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/). Valid choices are nanos, micros, ms, s, m, h, d.
v – Enables verbose mode, which displays column headers. Default is false.
index –
params (Any) –
headers (Any) –

Return type:

Any

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

Returns information about all snapshot repositories for a cluster.

Parameters:

cluster_manager_timeout – The amount of time allowed to establish a connection to the 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, such as json or yaml.
h – A comma-separated list of column names to display.
help – Returns help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
local – Returns local information but does not retrieve the state from the cluster manager node. Default is false.
(Deprecated (master_timeout) – To promote inclusive language, use cluster_manager_timeout instead.): The amount of time allowed to establish a connection to the cluster manager node.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – A 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 – Enables verbose mode, which displays column headers. Default is false.
params (Any) –
headers (Any) –

Return type:

Any

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

Returns information about active and last-completed segment replication events on each replica shard, including related shard-level metrics. These metrics provide information about how far behind the primary shard the replicas are lagging.

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.
active_only – When true, the response only includes ongoing segment replication events. Default is false.
allow_no_indices – Whether to ignore the index if a wildcard index expression resolves to no concrete indexes. This includes the _all string or when no indexes have been specified.
bytes – The units used to display byte values. Valid choices are b, kb, k, mb, m, gb, g, tb, t, pb, p.
completed_only – When true, the response only includes the last-completed segment replication events. Default is false.
detailed – When true, the response includes additional metrics for each stage of a segment replication event. Default is false.
error_trace – Whether to include the stack trace of returned errors. Default is false.
expand_wildcards – Specifies the type of index that wildcard expressions can match. Supports comma-separated values. Valid choices are all, closed, hidden, none, open.
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, such as json or yaml.
h – A comma-separated list of column names to display.
help – Returns 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 the specified concrete indexes should be ignored when missing or closed.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – A comma-separated list of column names or column aliases to sort by.
shards – A 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 – Specifies the time units, for example, 5d or 7h. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/). Valid choices are nanos, micros, ms, s, m, h, d.
timeout – The operation timeout.
v – Enables verbose mode, which displays 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 units used to display byte values. Valid choices are b, kb, k, mb, m, gb, g, tb, t, pb, p.
cluster_manager_timeout – The amount of time allowed to establish a connection to the 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, such as json or yaml.
h – A comma-separated list of column names to display.
help – Returns 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.): The amount of time allowed to establish a connection to the cluster manager node.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – A 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 – Enables verbose mode, which displays column headers. Default is false.
index –
params (Any) –
headers (Any) –

Return type:

Any

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

Lists the states of all primary and replica shards and how they are distributed.

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 units used to display byte values. Valid choices are b, kb, k, mb, m, gb, g, tb, t, pb, p.
cluster_manager_timeout – The amount of time allowed to establish a connection to the 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, such as json or yaml.
h – A comma-separated list of column names to display.
help – Returns help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
local – Returns local information but does not retrieve the state from the cluster manager node. Default is false.
(Deprecated (master_timeout) – To promote inclusive language, use cluster_manager_timeout instead.): The amount of time allowed to establish a connection to the cluster manager node.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – A 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 – Specifies the time units, for example, 5d or 7h. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/). Valid choices are nanos, micros, ms, s, m, h, d.
v – Enables verbose mode, which displays column headers. Default is false.
index –
params (Any) –
headers (Any) –

Return type:

Any

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

Lists all of the snapshots stored 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 – The amount of time allowed to establish a connection to the 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, such as json or yaml.
h – A comma-separated list of column names to display.
help – Returns help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
ignore_unavailable – When 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.): The amount of time allowed to establish a connection to the cluster manager node.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – A 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 – Specifies the time units, for example, 5d or 7h. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/). Valid choices are nanos, micros, ms, s, m, h, d.
v – Enables verbose mode, which displays column headers. Default is false.
repository –
params (Any) –
headers (Any) –

Return type:

Any

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

Lists the progress of all tasks currently running on the cluster.

Parameters:

actions – The task action names 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, such as json or yaml.
h – A comma-separated list of column names to display.
help – Returns help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
nodes – A comma-separated list of node IDs or names used to limit the returned information. Use _local to return information from the node to which you’re connecting, specify a specific node from which to get information, or keep the parameter 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 – A 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 – Specifies the time units, for example, 5d or 7h. For more information, see [Supported units](https://opensearch.org/docs/latest/api-reference/units/). Valid choices are nanos, micros, ms, s, m, h, d.
v – Enables verbose mode, which displays column headers. Default is false.
params (Any) –
headers (Any) –

Return type:

Any

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

Lists the names, patterns, order numbers, and version numbers of index templates.

Parameters:

name (Any) – The name of the template to return. Accepts wildcard expressions. If omitted, all templates are returned.
cluster_manager_timeout – The amount of time allowed to establish a connection to the 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, such as json or yaml.
h – A comma-separated list of column names to display.
help – Returns help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
local – Returns local information but does not retrieve the state from the cluster manager node. Default is false.
(Deprecated (master_timeout) – To promote inclusive language, use cluster_manager_timeout instead.): The amount of time allowed to establish a connection to the cluster manager node.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – A 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 – Enables verbose mode, which displays 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, queued, 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 – A timeout for connection to the 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, such as json or yaml.
h – A comma-separated list of column names to display.
help – Returns help information. Default is false.
human – Whether to return human readable values for statistics. Default is True.
local – Returns local information but does not retrieve the state from the cluster manager node. Default is false.
(Deprecated (master_timeout) – To promote inclusive language, use cluster_manager_timeout instead.): The amount of time allowed to establish a connection to the cluster manager node.
pretty – Whether to pretty format the returned JSON response. Default is false.
s – A 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 – Enables verbose mode, which displays column headers. Default is false.
thread_pool_patterns –
params (Any) –
headers (Any) –

Return type:

Any