New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Elasticsearch\ClientBuilder Elasticsearch\Namespaces\ClusterNamespace »
Elastic Docs ›Elasticsearch-PHP [2.x] ›Reference - Endpoints

Elasticsearch\Namespaces\CatNamespace

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Elasticsearch\Namespaces\CatNamespace

edit

Class CatNamespace

Methods

The class defines the following methods:

aliases()

/*
$params['name']           = (list) A comma-separated list of alias names to return
       ['local']          = (boolean) 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']           = (boolean) Return help information (default: false)
       ['v']              = (boolean) Verbose mode. Display column headers (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->cat()->aliases($params);

allocation()

/*
$params['node_id']        = (list) A comma-separated list of node IDs or names to limit the returned information
       ['bytes']          = (enum) The unit in which to display byte values (b,k,m,g)
       ['local']          = (boolean) 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']           = (boolean) Return help information (default: false)
       ['v']              = (boolean) Verbose mode. Display column headers (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->cat()->allocation($params);

count()

/*
$params['index']          = (list) A comma-separated list of index names to limit the returned information
       ['local']          = (boolean) 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']           = (boolean) Return help information (default: false)
       ['v']              = (boolean) Verbose mode. Display column headers (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->cat()->count($params);

health()

/*
$params['local']          = (boolean) 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']           = (boolean) Return help information (default: false)
       ['ts']             = (boolean) Set to false to disable timestamping (default: true)
       ['v']              = (boolean) Verbose mode. Display column headers (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->cat()->health($params);

help()

/*
$params['help'] = (boolean) Return help information(default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->cat()->help($params);

indices()

/*
$params['index']          = (list) A comma-separated list of index names to limit the returned information
       ['bytes']          = (enum) The unit in which to display byte values (b,k,m,g)
       ['local']          = (boolean) 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']           = (boolean) Return help information (default: false)
       ['pri']            = (boolean) Set to true to return stats only for primary shards (default: false)
       ['v']              = (boolean) Verbose mode. Display column headers (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->cat()->indices($params);

master()

/*
$params['local']          = (boolean) 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']           = (boolean) Return help information (default: false)
       ['v']              = (boolean) Verbose mode. Display column headers (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->cat()->master($params);

nodes()

/*
$params['local']          = (boolean) 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']           = (boolean) Return help information (default: false)
       ['v']              = (boolean) Verbose mode. Display column headers (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->cat()->nodes($params);

nodeAttrs()

/*
$params['local']          = (boolean) 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']           = (boolean) Return help information (default: false)
       ['v']              = (boolean) Verbose mode. Display column headers (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->cat()->nodeAttrs($params);

pendingTasks()

/*
$params['local']          = (boolean) 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']           = (boolean) Return help information (default: false)
       ['v']              = (boolean) Verbose mode. Display column headers (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->cat()->pendingTasks($params);

recovery()

/*
$params['index']          = (list) A comma-separated list of index names to limit the returned information
       ['bytes']          = (enum) The unit in which to display byte values (b,k,m,g)
       ['master_timeout'] = (time) Explicit operation timeout for connection to master node
       ['h']              = (list) Comma-separated list of column names to display
       ['help']           = (boolean) Return help information (default: false)
       ['v']              = (boolean) Verbose mode. Display column headers (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->cat()->recovery($params);

repositories()

/*
$params['local']          = (boolean) 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']           = (boolean) Return help information (default: false)
       ['v']              = (boolean) Verbose mode. Display column headers (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->cat()->repositories($params);

shards()

/*
$params['index']          = (list) A comma-separated list of index names to limit the returned information
       ['bytes']          = (enum) The unit in which to display byte values
       ['local']          = (boolean) 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']           = (boolean) Return help information (default: false)
       ['v']              = (boolean) Verbose mode. Display column headers (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->cat()->shards($params);

snapshots()

/*
$params['repository']         = (list) Name of repository from which to fetch the snapshot information (Required)
       ['local']              = (bool) Return local information, do not retrieve the state from master node
(default: false)
       ['ignore_unavailable'] = (boolean) Set to true to ignore unavailable snapshots (default: false)
       ['master_timeout']     = (time) Explicit operation timeout for connection to master node
       ['h']                  = (list) Comma-separated list of column names to display
       ['help']               = (boolean) Return help information (default: false)
       ['v']                  = (boolean) Verbose mode. Display column headers (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->cat()->snapshots($params);

threadPool()

/*
$params['local']          = (boolean) 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']           = (boolean) Return help information (default: false)
       ['v']              = (boolean) Verbose mode. Display column headers (default: false)
       ['full_id']        = (boolean) Enables displaying the complete node ids (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->cat()->threadPool($params);

fielddata()

/*
$params['fields']         = (list) A comma-separated list of fields to return in the output
       ['bytes']          = (enum) The unit in which to display byte values (b,k,m,g)
       ['local']          = (boolean) 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']           = (boolean) Return help information (default: false)
       ['v']              = (boolean) Verbose mode. Display column headers (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->cat()->fielddata($params);

plugins()

/*
$params['local']          = (boolean) 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']           = (boolean) Return help information (default: false)
       ['v']              = (boolean) Verbose mode. Display column headers (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->cat()->plugins($params);

segments()

/*
$params['index'] = (list) A comma-separated list of index names to limit the returned information
       ['h']     = (list) Comma-separated list of column names to display
       ['help']  = (boolean) Return help information (default: false)
       ['v']     = (boolean) Verbose mode. Display column headers (default: false)
       ['body']  = (array) Request body
*/

$params = [
    // ...
];

$client = ClientBuilder::create()->build();
$response = $client->cat()->segments($params);
« Elasticsearch\ClientBuilder Elasticsearch\Namespaces\ClusterNamespace »
Was this helpful?
Feedback