Class OpenSearch\Namespaces\ListNamespace

Returns help for the List APIs.

$params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) 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 "-".

Returns paginated information about indexes including number of primaries and replicas, document counts, disk size.

$params['index'] = (array) 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. $params['bytes'] = (enum) The unit used to display byte values. (Options = b,g,gb,k,kb,m,mb,p,pb,t,tb) $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. $params['expand_wildcards'] = (any) The type of index that wildcard patterns can match. $params['format'] = (string) A short version of the Accept header, such as JSON, YAML. $params['h'] = (array) Comma-separated list of column names to display. $params['health'] = (enum) The health status used to limit returned indexes. By default, the response includes indexes of any health status. (Options = green,red,yellow) $params['help'] = (boolean) Return help information. (Default = false) $params['include_unloaded_segments'] = (boolean) If true, the response includes information from segments that are not loaded into memory. (Default = false) $params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false) $params['master_timeout'] = (string) Operation timeout for connection to cluster manager node. $params['next_token'] = (Array) Token to retrieve next page of indexes. $params['pri'] = (boolean) If true, the response only includes information from primary shards. (Default = false) $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. $params['size'] = (integer) Maximum number of indexes to be displayed in a page. $params['sort'] = (enum) Defines order in which indexes will be displayed. Accepted values are asc and desc. If desc, most recently created indexes would be displayed first. (Options = asc,desc) $params['time'] = (enum) The unit used to display time values. (Options = d,h,m,micros,ms,nanos,s) $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) 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 "-".

Returns paginated details of shard allocation on nodes.

$params['index'] = (array) 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. $params['bytes'] = (enum) The unit used to display byte values. (Options = b,g,gb,k,kb,m,mb,p,pb,t,tb) $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. $params['format'] = (string) A short version of the Accept header, such as JSON, YAML. $params['h'] = (array) Comma-separated list of column names to display. $params['help'] = (boolean) Return help information. (Default = false) $params['local'] = (boolean) Return local information, do not retrieve the state from cluster-manager node. (Default = false) $params['master_timeout'] = (string) Operation timeout for connection to cluster manager node. $params['next_token'] = (Array) Token to retrieve next page of shards. $params['s'] = (array) Comma-separated list of column names or column aliases to sort by. $params['size'] = (integer) Maximum number of shards to be displayed in a page. $params['sort'] = (enum) Defines order in which shards will be displayed. Accepted values are asc and desc. If desc, most recently created shards would be displayed first. (Options = asc,desc) $params['time'] = (enum) The unit in which to display time values. (Options = d,h,m,micros,ms,nanos,s) $params['v'] = (boolean) Verbose mode. Display column headers. (Default = false) $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) 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 "-".