Class CatNamespace
Methods
The class defines the following methods:
aliases()/*
$params['local'] = (bool) Return local information, do not retrieve the state from master node (default: false)
['master_timeout'] = (time) Explicit operation timeout for connection to master node
['h'] = (list) Comma-separated list of column names to display
['help'] = (bool) Return help information
['v'] = (bool) Verbose mode. Display column headers
['body'] = (array) Request body
*/
$params = [
// ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->aliases($params);allocation()/*
$params['local'] = (bool) Return local information, do not retrieve the state from master node (default: false)
['master_timeout'] = (time) Explicit operation timeout for connection to master node
['h'] = (list) Comma-separated list of column names to display
['help'] = (bool) Return help information
['v'] = (bool) Verbose mode. Display column headers
['bytes'] = (enum) The unit in which to display byte values
['body'] = (array) Request body
*/
$params = [
// ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->allocation($params);count()/*
$params['local'] = (bool) Return local information, do not retrieve the state from master node (default: false)
['master_timeout'] = (time) Explicit operation timeout for connection to master node
['h'] = (list) Comma-separated list of column names to display
['help'] = (bool) Return help information
['v'] = (bool) Verbose mode. Display column headers
['body'] = (array) Request body
*/
$params = [
// ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->count($params);health()/*
$params['local'] = (bool) Return local information, do not retrieve the state from master node (default: false)
['master_timeout'] = (time) Explicit operation timeout for connection to master node
['h'] = (list) Comma-separated list of column names to display
['help'] = (bool) Return help information
['v'] = (bool) Verbose mode. Display column headers
['ts'] = (bool) Set to false to disable timestamping
['body'] = (array) Request body
*/
$params = [
// ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->health($params);help()/*
$params['help'] = (bool) Return help information
['body'] = (array) Request body
*/
$params = [
// ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->help($params);indices()/*
$params['local'] = (bool) Return local information, do not retrieve the state from master node (default: false)
['master_timeout'] = (time) Explicit operation timeout for connection to master node
['h'] = (list) Comma-separated list of column names to display
['help'] = (bool) Return help information
['v'] = (bool) Verbose mode. Display column headers
['bytes'] = (enum) The unit in which to display byte values
['pri'] = (bool) Set to true to return stats only for primary shards
['body'] = (array) Request body
*/
$params = [
// ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->indices($params);master()/*
$params['local'] = (bool) Return local information, do not retrieve the state from master node (default: false)
['master_timeout'] = (time) Explicit operation timeout for connection to master node
['h'] = (list) Comma-separated list of column names to display
['help'] = (bool) Return help information
['v'] = (bool) Verbose mode. Display column headers
['body'] = (array) Request body
*/
$params = [
// ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->master($params);nodes()/*
$params['local'] = (bool) Return local information, do not retrieve the state from master node (default: false)
['master_timeout'] = (time) Explicit operation timeout for connection to master node
['h'] = (list) Comma-separated list of column names to display
['help'] = (bool) Return help information
['v'] = (bool) Verbose mode. Display column headers
['body'] = (array) Request body
*/
$params = [
// ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->nodes($params);nodeAttrs()/*
$params['local'] = (bool) Return local information, do not retrieve the state from master node (default: false)
['master_timeout'] = (time) Explicit operation timeout for connection to master node
['h'] = (list) Comma-separated list of column names to display
['help'] = (bool) Return help information
['v'] = (bool) Verbose mode. Display column headers
['body'] = (array) Request body
*/
$params = [
// ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->nodeAttrs($params);pendingTasks()/*
$params['local'] = (bool) Return local information, do not retrieve the state from master node (default: false)
['master_timeout'] = (time) Explicit operation timeout for connection to master node
['h'] = (list) Comma-separated list of column names to display
['help'] = (bool) Return help information
['v'] = (bool) Verbose mode. Display column headers
['body'] = (array) Request body
*/
$params = [
// ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->pendingTasks($params);recovery()/*
$params['local'] = (bool) Return local information, do not retrieve the state from master node (default: false)
['master_timeout'] = (time) Explicit operation timeout for connection to master node
['h'] = (list) Comma-separated list of column names to display
['help'] = (bool) Return help information
['v'] = (bool) Verbose mode. Display column headers
['bytes'] = (enum) The unit in which to display byte values
['body'] = (array) Request body
*/
$params = [
// ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->recovery($params);repositories()/*
$params['local'] = (bool) Return local information, do not retrieve the state from master node (default: false)
['master_timeout'] = (time) Explicit operation timeout for connection to master node
['h'] = (list) Comma-separated list of column names to display
['help'] = (bool) Return help information
['v'] = (bool) Verbose mode. Display column headers
['body'] = (array) Request body
*/
$params = [
// ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->repositories($params);shards()/*
$params['local'] = (bool) Return local information, do not retrieve the state from master node (default: false)
['master_timeout'] = (time) Explicit operation timeout for connection to master node
['h'] = (list) Comma-separated list of column names to display
['help'] = (bool) Return help information
['v'] = (bool) Verbose mode. Display column headers
['bytes'] = (enum) The unit in which to display byte values
['body'] = (array) Request body
*/
$params = [
// ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->shards($params);snapshots()/*
$params['local'] = (bool) Return local information, do not retrieve the state from master node (default: false)
['master_timeout'] = (time) Explicit operation timeout for connection to master node
['h'] = (list) Comma-separated list of column names to display
['help'] = (bool) Return help information
['v'] = (bool) Verbose mode. Display column headers
['bytes'] = (enum) The unit in which to display byte values
['repository'] = (string) Name of repository from which to fetch the snapshot information
['body'] = (array) Request body
*/
$params = [
// ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->snapshots($params);threadPool()/*
$params['local'] = (bool) Return local information, do not retrieve the state from master node (default: false)
['master_timeout'] = (time) Explicit operation timeout for connection to master node
['h'] = (list) Comma-separated list of column names to display
['help'] = (bool) Return help information
['v'] = (bool) Verbose mode. Display column headers
['full_id'] = (bool) Enables displaying the complete node ids
['size'] = (enum) The multiplier in which to display values ([ "", "k", "m", "g", "t", "p" ])
['body'] = (array) Request body
*/
$params = [
// ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->threadPool($params);fielddata()/*
$params['local'] = (bool) Return local information, do not retrieve the state from master node (default: false)
['master_timeout'] = (time) Explicit operation timeout for connection to master node
['h'] = (list) Comma-separated list of column names to display
['help'] = (bool) Return help information
['v'] = (bool) Verbose mode. Display column headers
['bytes'] = (enum) The unit in which to display byte values
['fields'] = (list) A comma-separated list of fields to return the fielddata size
['body'] = (array) Request body
*/
$params = [
// ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->fielddata($params);plugins()/*
$params['local'] = (bool) Return local information, do not retrieve the state from master node (default: false)
['master_timeout'] = (time) Explicit operation timeout for connection to master node
['h'] = (list) Comma-separated list of column names to display
['help'] = (bool) Return help information
['v'] = (bool) Verbose mode. Display column headers
['body'] = (array) Request body
*/
$params = [
// ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->plugins($params);segments()/*
$params['h'] = (list) Comma-separated list of column names to display
['help'] = (bool) Return help information
['v'] = (bool) Verbose mode. Display column headers
['body'] = (array) Request body
*/
$params = [
// ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->segments($params);tasks()/*
$params['format'] = (string) a short version of the Accept header, e.g. json, yaml
['node_id'] = (list) A 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
['format'] = (string) a short version of the Accept header, e.g. json, yaml
['actions'] = (list) A comma-separated list of actions that should be returned. Leave empty to return all.
['body'] = (array) Request body
*/
$params = [
// ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->tasks($params);