1 2 3[[Elasticsearch_Namespaces_CatNamespace]] 4=== Elasticsearch\Namespaces\CatNamespace 5 6 7 8Class CatNamespace 9 10*Description* 11 12 13NOTE: this file is autogenerated using util/GenerateEndpoints.php 14and Elasticsearch 7.12.1 (3186837139b9c6b6d23c3200870651f10d3343b7) 15 16 17*Methods* 18 19The class defines the following methods: 20 21* <<Elasticsearch_Namespaces_CatNamespacealiases_aliases,`aliases()`>> 22* <<Elasticsearch_Namespaces_CatNamespaceallocation_allocation,`allocation()`>> 23* <<Elasticsearch_Namespaces_CatNamespacecount_count,`count()`>> 24* <<Elasticsearch_Namespaces_CatNamespacefielddata_fielddata,`fielddata()`>> 25* <<Elasticsearch_Namespaces_CatNamespacehealth_health,`health()`>> 26* <<Elasticsearch_Namespaces_CatNamespacehelp_help,`help()`>> 27* <<Elasticsearch_Namespaces_CatNamespaceindices_indices,`indices()`>> 28* <<Elasticsearch_Namespaces_CatNamespacemaster_master,`master()`>> 29* <<Elasticsearch_Namespaces_CatNamespacemlDataFrameAnalytics_mlDataFrameAnalytics,`mlDataFrameAnalytics()`>> 30* <<Elasticsearch_Namespaces_CatNamespacemlDatafeeds_mlDatafeeds,`mlDatafeeds()`>> 31* <<Elasticsearch_Namespaces_CatNamespacemlJobs_mlJobs,`mlJobs()`>> 32* <<Elasticsearch_Namespaces_CatNamespacemlTrainedModels_mlTrainedModels,`mlTrainedModels()`>> 33* <<Elasticsearch_Namespaces_CatNamespacenodeattrs_nodeattrs,`nodeattrs()`>> 34* <<Elasticsearch_Namespaces_CatNamespacenodes_nodes,`nodes()`>> 35* <<Elasticsearch_Namespaces_CatNamespacependingTasks_pendingTasks,`pendingTasks()`>> 36* <<Elasticsearch_Namespaces_CatNamespaceplugins_plugins,`plugins()`>> 37* <<Elasticsearch_Namespaces_CatNamespacerecovery_recovery,`recovery()`>> 38* <<Elasticsearch_Namespaces_CatNamespacerepositories_repositories,`repositories()`>> 39* <<Elasticsearch_Namespaces_CatNamespacesegments_segments,`segments()`>> 40* <<Elasticsearch_Namespaces_CatNamespaceshards_shards,`shards()`>> 41* <<Elasticsearch_Namespaces_CatNamespacesnapshots_snapshots,`snapshots()`>> 42* <<Elasticsearch_Namespaces_CatNamespacetasks_tasks,`tasks()`>> 43* <<Elasticsearch_Namespaces_CatNamespacetemplates_templates,`templates()`>> 44* <<Elasticsearch_Namespaces_CatNamespacethreadPool_threadPool,`threadPool()`>> 45* <<Elasticsearch_Namespaces_CatNamespacetransforms_transforms,`transforms()`>> 46 47 48 49[[Elasticsearch_Namespaces_CatNamespacealiases_aliases]] 50.`aliases(array $params = [])` 51**** 52[source,php] 53---- 54/* 55$params['name'] = (list) A comma-separated list of alias names to return 56$params['format'] = (string) a short version of the Accept header, e.g. json, yaml 57$params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) 58$params['h'] = (list) Comma-separated list of column names to display 59$params['help'] = (boolean) Return help information (Default = false) 60$params['s'] = (list) Comma-separated list of column names or column aliases to sort by 61$params['v'] = (boolean) Verbose mode. Display column headers (Default = false) 62$params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = all) 63*/ 64---- 65**** 66 67 68 69[[Elasticsearch_Namespaces_CatNamespaceallocation_allocation]] 70.`allocation(array $params = [])` 71**** 72[source,php] 73---- 74/* 75$params['node_id'] = (list) A comma-separated list of node IDs or names to limit the returned information 76$params['format'] = (string) a short version of the Accept header, e.g. json, yaml 77$params['bytes'] = (enum) The unit in which to display byte values (Options = b,k,kb,m,mb,g,gb,t,tb,p,pb) 78$params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) 79$params['master_timeout'] = (time) Explicit operation timeout for connection to master node 80$params['h'] = (list) Comma-separated list of column names to display 81$params['help'] = (boolean) Return help information (Default = false) 82$params['s'] = (list) Comma-separated list of column names or column aliases to sort by 83$params['v'] = (boolean) Verbose mode. Display column headers (Default = false) 84*/ 85---- 86**** 87 88 89 90[[Elasticsearch_Namespaces_CatNamespacecount_count]] 91.`count(array $params = [])` 92**** 93[source,php] 94---- 95/* 96$params['index'] = (list) A comma-separated list of index names to limit the returned information 97$params['format'] = (string) a short version of the Accept header, e.g. json, yaml 98$params['h'] = (list) Comma-separated list of column names to display 99$params['help'] = (boolean) Return help information (Default = false) 100$params['s'] = (list) Comma-separated list of column names or column aliases to sort by 101$params['v'] = (boolean) Verbose mode. Display column headers (Default = false) 102*/ 103---- 104**** 105 106 107 108[[Elasticsearch_Namespaces_CatNamespacefielddata_fielddata]] 109.`fielddata(array $params = [])` 110**** 111[source,php] 112---- 113/* 114$params['fields'] = (list) A comma-separated list of fields to return the fielddata size 115$params['format'] = (string) a short version of the Accept header, e.g. json, yaml 116$params['bytes'] = (enum) The unit in which to display byte values (Options = b,k,kb,m,mb,g,gb,t,tb,p,pb) 117$params['h'] = (list) Comma-separated list of column names to display 118$params['help'] = (boolean) Return help information (Default = false) 119$params['s'] = (list) Comma-separated list of column names or column aliases to sort by 120$params['v'] = (boolean) Verbose mode. Display column headers (Default = false) 121*/ 122---- 123**** 124 125 126 127[[Elasticsearch_Namespaces_CatNamespacehealth_health]] 128.`health(array $params = [])` 129**** 130[source,php] 131---- 132/* 133$params['format'] = (string) a short version of the Accept header, e.g. json, yaml 134$params['h'] = (list) Comma-separated list of column names to display 135$params['help'] = (boolean) Return help information (Default = false) 136$params['s'] = (list) Comma-separated list of column names or column aliases to sort by 137$params['time'] = (enum) The unit in which to display time values (Options = d,h,m,s,ms,micros,nanos) 138$params['ts'] = (boolean) Set to false to disable timestamping (Default = true) 139$params['v'] = (boolean) Verbose mode. Display column headers (Default = false) 140*/ 141---- 142**** 143 144 145 146[[Elasticsearch_Namespaces_CatNamespacehelp_help]] 147.`help(array $params = [])` 148**** 149[source,php] 150---- 151/* 152$params['help'] = (boolean) Return help information (Default = false) 153$params['s'] = (list) Comma-separated list of column names or column aliases to sort by 154*/ 155---- 156**** 157 158 159 160[[Elasticsearch_Namespaces_CatNamespaceindices_indices]] 161.`indices(array $params = [])` 162**** 163[source,php] 164---- 165/* 166$params['index'] = (list) A comma-separated list of index names to limit the returned information 167$params['format'] = (string) a short version of the Accept header, e.g. json, yaml 168$params['bytes'] = (enum) The unit in which to display byte values (Options = b,k,kb,m,mb,g,gb,t,tb,p,pb) 169$params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) 170$params['master_timeout'] = (time) Explicit operation timeout for connection to master node 171$params['h'] = (list) Comma-separated list of column names to display 172$params['health'] = (enum) A health status ("green", "yellow", or "red" to filter only indices matching the specified health status (Options = green,yellow,red) 173$params['help'] = (boolean) Return help information (Default = false) 174$params['pri'] = (boolean) Set to true to return stats only for primary shards (Default = false) 175$params['s'] = (list) Comma-separated list of column names or column aliases to sort by 176$params['time'] = (enum) The unit in which to display time values (Options = d,h,m,s,ms,micros,nanos) 177$params['v'] = (boolean) Verbose mode. Display column headers (Default = false) 178$params['include_unloaded_segments'] = (boolean) If set to true segment stats will include stats for segments that are not currently loaded into memory (Default = false) 179$params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = all) 180*/ 181---- 182**** 183 184 185 186[[Elasticsearch_Namespaces_CatNamespacemaster_master]] 187.`master(array $params = [])` 188**** 189[source,php] 190---- 191/* 192$params['format'] = (string) a short version of the Accept header, e.g. json, yaml 193$params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) 194$params['master_timeout'] = (time) Explicit operation timeout for connection to master node 195$params['h'] = (list) Comma-separated list of column names to display 196$params['help'] = (boolean) Return help information (Default = false) 197$params['s'] = (list) Comma-separated list of column names or column aliases to sort by 198$params['v'] = (boolean) Verbose mode. Display column headers (Default = false) 199*/ 200---- 201**** 202 203 204 205[[Elasticsearch_Namespaces_CatNamespacemlDataFrameAnalytics_mlDataFrameAnalytics]] 206.`mlDataFrameAnalytics(array $params = [])` 207**** 208[source,php] 209---- 210/* 211$params['id'] = (string) The ID of the data frame analytics to fetch 212$params['allow_no_match'] = (boolean) Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified) 213$params['bytes'] = (enum) The unit in which to display byte values (Options = b,k,kb,m,mb,g,gb,t,tb,p,pb) 214$params['format'] = (string) a short version of the Accept header, e.g. json, yaml 215$params['h'] = (list) Comma-separated list of column names to display 216$params['help'] = (boolean) Return help information (Default = false) 217$params['s'] = (list) Comma-separated list of column names or column aliases to sort by 218$params['time'] = (enum) The unit in which to display time values (Options = d,h,m,s,ms,micros,nanos) 219$params['v'] = (boolean) Verbose mode. Display column headers (Default = false) 220*/ 221---- 222**** 223 224 225 226[[Elasticsearch_Namespaces_CatNamespacemlDatafeeds_mlDatafeeds]] 227.`mlDatafeeds(array $params = [])` 228**** 229[source,php] 230---- 231/* 232$params['datafeed_id'] = (string) The ID of the datafeeds stats to fetch 233$params['allow_no_match'] = (boolean) Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) 234$params['allow_no_datafeeds'] = (boolean) Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) 235$params['format'] = (string) a short version of the Accept header, e.g. json, yaml 236$params['h'] = (list) Comma-separated list of column names to display 237$params['help'] = (boolean) Return help information (Default = false) 238$params['s'] = (list) Comma-separated list of column names or column aliases to sort by 239$params['time'] = (enum) The unit in which to display time values (Options = d,h,m,s,ms,micros,nanos) 240$params['v'] = (boolean) Verbose mode. Display column headers (Default = false) 241*/ 242---- 243**** 244 245 246 247[[Elasticsearch_Namespaces_CatNamespacemlJobs_mlJobs]] 248.`mlJobs(array $params = [])` 249**** 250[source,php] 251---- 252/* 253$params['job_id'] = (string) The ID of the jobs stats to fetch 254$params['allow_no_match'] = (boolean) Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) 255$params['allow_no_jobs'] = (boolean) Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) 256$params['bytes'] = (enum) The unit in which to display byte values (Options = b,k,kb,m,mb,g,gb,t,tb,p,pb) 257$params['format'] = (string) a short version of the Accept header, e.g. json, yaml 258$params['h'] = (list) Comma-separated list of column names to display 259$params['help'] = (boolean) Return help information (Default = false) 260$params['s'] = (list) Comma-separated list of column names or column aliases to sort by 261$params['time'] = (enum) The unit in which to display time values (Options = d,h,m,s,ms,micros,nanos) 262$params['v'] = (boolean) Verbose mode. Display column headers (Default = false) 263*/ 264---- 265**** 266 267 268 269[[Elasticsearch_Namespaces_CatNamespacemlTrainedModels_mlTrainedModels]] 270.`mlTrainedModels(array $params = [])` 271**** 272[source,php] 273---- 274/* 275$params['model_id'] = (string) The ID of the trained models stats to fetch 276$params['allow_no_match'] = (boolean) Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified) (Default = true) 277$params['from'] = (int) skips a number of trained models (Default = 0) 278$params['size'] = (int) specifies a max number of trained models to get (Default = 100) 279$params['bytes'] = (enum) The unit in which to display byte values (Options = b,k,kb,m,mb,g,gb,t,tb,p,pb) 280$params['format'] = (string) a short version of the Accept header, e.g. json, yaml 281$params['h'] = (list) Comma-separated list of column names to display 282$params['help'] = (boolean) Return help information (Default = false) 283$params['s'] = (list) Comma-separated list of column names or column aliases to sort by 284$params['time'] = (enum) The unit in which to display time values (Options = d,h,m,s,ms,micros,nanos) 285$params['v'] = (boolean) Verbose mode. Display column headers (Default = false) 286*/ 287---- 288**** 289 290 291 292[[Elasticsearch_Namespaces_CatNamespacenodeattrs_nodeattrs]] 293.`nodeattrs(array $params = [])` 294**** 295[source,php] 296---- 297/* 298$params['format'] = (string) a short version of the Accept header, e.g. json, yaml 299$params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) 300$params['master_timeout'] = (time) Explicit operation timeout for connection to master node 301$params['h'] = (list) Comma-separated list of column names to display 302$params['help'] = (boolean) Return help information (Default = false) 303$params['s'] = (list) Comma-separated list of column names or column aliases to sort by 304$params['v'] = (boolean) Verbose mode. Display column headers (Default = false) 305*/ 306---- 307**** 308 309 310 311[[Elasticsearch_Namespaces_CatNamespacenodes_nodes]] 312.`nodes(array $params = [])` 313**** 314[source,php] 315---- 316/* 317$params['bytes'] = (enum) The unit in which to display byte values (Options = b,k,kb,m,mb,g,gb,t,tb,p,pb) 318$params['format'] = (string) a short version of the Accept header, e.g. json, yaml 319$params['full_id'] = (boolean) Return the full node ID instead of the shortened version (default: false) 320$params['local'] = (boolean) Calculate the selected nodes using the local cluster state rather than the state from master node (default: false) 321$params['master_timeout'] = (time) Explicit operation timeout for connection to master node 322$params['h'] = (list) Comma-separated list of column names to display 323$params['help'] = (boolean) Return help information (Default = false) 324$params['s'] = (list) Comma-separated list of column names or column aliases to sort by 325$params['time'] = (enum) The unit in which to display time values (Options = d,h,m,s,ms,micros,nanos) 326$params['v'] = (boolean) Verbose mode. Display column headers (Default = false) 327*/ 328---- 329**** 330 331 332 333[[Elasticsearch_Namespaces_CatNamespacependingTasks_pendingTasks]] 334.`pendingTasks(array $params = [])` 335**** 336[source,php] 337---- 338/* 339$params['format'] = (string) a short version of the Accept header, e.g. json, yaml 340$params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) 341$params['master_timeout'] = (time) Explicit operation timeout for connection to master node 342$params['h'] = (list) Comma-separated list of column names to display 343$params['help'] = (boolean) Return help information (Default = false) 344$params['s'] = (list) Comma-separated list of column names or column aliases to sort by 345$params['time'] = (enum) The unit in which to display time values (Options = d,h,m,s,ms,micros,nanos) 346$params['v'] = (boolean) Verbose mode. Display column headers (Default = false) 347*/ 348---- 349**** 350 351 352 353[[Elasticsearch_Namespaces_CatNamespaceplugins_plugins]] 354.`plugins(array $params = [])` 355**** 356[source,php] 357---- 358/* 359$params['format'] = (string) a short version of the Accept header, e.g. json, yaml 360$params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) 361$params['master_timeout'] = (time) Explicit operation timeout for connection to master node 362$params['h'] = (list) Comma-separated list of column names to display 363$params['help'] = (boolean) Return help information (Default = false) 364$params['include_bootstrap'] = (boolean) Include bootstrap plugins in the response (Default = false) 365$params['s'] = (list) Comma-separated list of column names or column aliases to sort by 366$params['v'] = (boolean) Verbose mode. Display column headers (Default = false) 367*/ 368---- 369**** 370 371 372 373[[Elasticsearch_Namespaces_CatNamespacerecovery_recovery]] 374.`recovery(array $params = [])` 375**** 376[source,php] 377---- 378/* 379$params['index'] = (list) Comma-separated list or wildcard expression of index names to limit the returned information 380$params['format'] = (string) a short version of the Accept header, e.g. json, yaml 381$params['active_only'] = (boolean) If `true`, the response only includes ongoing shard recoveries (Default = false) 382$params['bytes'] = (enum) The unit in which to display byte values (Options = b,k,kb,m,mb,g,gb,t,tb,p,pb) 383$params['detailed'] = (boolean) If `true`, the response includes detailed information about shard recoveries (Default = false) 384$params['h'] = (list) Comma-separated list of column names to display 385$params['help'] = (boolean) Return help information (Default = false) 386$params['s'] = (list) Comma-separated list of column names or column aliases to sort by 387$params['time'] = (enum) The unit in which to display time values (Options = d,h,m,s,ms,micros,nanos) 388$params['v'] = (boolean) Verbose mode. Display column headers (Default = false) 389*/ 390---- 391**** 392 393 394 395[[Elasticsearch_Namespaces_CatNamespacerepositories_repositories]] 396.`repositories(array $params = [])` 397**** 398[source,php] 399---- 400/* 401$params['format'] = (string) a short version of the Accept header, e.g. json, yaml 402$params['local'] = (boolean) Return local information, do not retrieve the state from master node (Default = false) 403$params['master_timeout'] = (time) Explicit operation timeout for connection to master node 404$params['h'] = (list) Comma-separated list of column names to display 405$params['help'] = (boolean) Return help information (Default = false) 406$params['s'] = (list) Comma-separated list of column names or column aliases to sort by 407$params['v'] = (boolean) Verbose mode. Display column headers (Default = false) 408*/ 409---- 410**** 411 412 413 414[[Elasticsearch_Namespaces_CatNamespacesegments_segments]] 415.`segments(array $params = [])` 416**** 417[source,php] 418---- 419/* 420$params['index'] = (list) A comma-separated list of index names to limit the returned information 421$params['format'] = (string) a short version of the Accept header, e.g. json, yaml 422$params['bytes'] = (enum) The unit in which to display byte values (Options = b,k,kb,m,mb,g,gb,t,tb,p,pb) 423$params['h'] = (list) Comma-separated list of column names to display 424$params['help'] = (boolean) Return help information (Default = false) 425$params['s'] = (list) Comma-separated list of column names or column aliases to sort by 426$params['v'] = (boolean) Verbose mode. Display column headers (Default = false) 427*/ 428---- 429**** 430 431 432 433[[Elasticsearch_Namespaces_CatNamespaceshards_shards]] 434.`shards(array $params = [])` 435**** 436[source,php] 437---- 438/* 439$params['index'] = (list) A comma-separated list of index names to limit the returned information 440$params['format'] = (string) a short version of the Accept header, e.g. json, yaml 441$params['bytes'] = (enum) The unit in which to display byte values (Options = b,k,kb,m,mb,g,gb,t,tb,p,pb) 442$params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) 443$params['master_timeout'] = (time) Explicit operation timeout for connection to master node 444$params['h'] = (list) Comma-separated list of column names to display 445$params['help'] = (boolean) Return help information (Default = false) 446$params['s'] = (list) Comma-separated list of column names or column aliases to sort by 447$params['time'] = (enum) The unit in which to display time values (Options = d,h,m,s,ms,micros,nanos) 448$params['v'] = (boolean) Verbose mode. Display column headers (Default = false) 449*/ 450---- 451**** 452 453 454 455[[Elasticsearch_Namespaces_CatNamespacesnapshots_snapshots]] 456.`snapshots(array $params = [])` 457**** 458[source,php] 459---- 460/* 461$params['repository'] = (list) Name of repository from which to fetch the snapshot information 462$params['format'] = (string) a short version of the Accept header, e.g. json, yaml 463$params['ignore_unavailable'] = (boolean) Set to true to ignore unavailable snapshots (Default = false) 464$params['master_timeout'] = (time) Explicit operation timeout for connection to master node 465$params['h'] = (list) Comma-separated list of column names to display 466$params['help'] = (boolean) Return help information (Default = false) 467$params['s'] = (list) Comma-separated list of column names or column aliases to sort by 468$params['time'] = (enum) The unit in which to display time values (Options = d,h,m,s,ms,micros,nanos) 469$params['v'] = (boolean) Verbose mode. Display column headers (Default = false) 470*/ 471---- 472**** 473 474 475 476[[Elasticsearch_Namespaces_CatNamespacetasks_tasks]] 477.`tasks(array $params = [])` 478**** 479[source,php] 480---- 481/* 482$params['format'] = (string) a short version of the Accept header, e.g. json, yaml 483$params['nodes'] = (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 484$params['actions'] = (list) A comma-separated list of actions that should be returned. Leave empty to return all. 485*/ 486---- 487**** 488 489 490 491[[Elasticsearch_Namespaces_CatNamespacetemplates_templates]] 492.`templates(array $params = [])` 493**** 494[source,php] 495---- 496/* 497$params['name'] = (string) A pattern that returned template names must match 498$params['format'] = (string) a short version of the Accept header, e.g. json, yaml 499$params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) 500$params['master_timeout'] = (time) Explicit operation timeout for connection to master node 501$params['h'] = (list) Comma-separated list of column names to display 502$params['help'] = (boolean) Return help information (Default = false) 503$params['s'] = (list) Comma-separated list of column names or column aliases to sort by 504$params['v'] = (boolean) Verbose mode. Display column headers (Default = false) 505*/ 506---- 507**** 508 509 510 511[[Elasticsearch_Namespaces_CatNamespacethreadPool_threadPool]] 512.`threadPool(array $params = [])` 513**** 514[source,php] 515---- 516/* 517$params['thread_pool_patterns'] = (list) A comma-separated list of regular-expressions to filter the thread pools in the output 518$params['format'] = (string) a short version of the Accept header, e.g. json, yaml 519$params['size'] = (enum) The multiplier in which to display values (Options = ,k,m,g,t,p) 520$params['local'] = (boolean) Return local information, do not retrieve the state from master node (default: false) 521$params['master_timeout'] = (time) Explicit operation timeout for connection to master node 522$params['h'] = (list) Comma-separated list of column names to display 523$params['help'] = (boolean) Return help information (Default = false) 524$params['s'] = (list) Comma-separated list of column names or column aliases to sort by 525$params['v'] = (boolean) Verbose mode. Display column headers (Default = false) 526*/ 527---- 528**** 529 530 531 532[[Elasticsearch_Namespaces_CatNamespacetransforms_transforms]] 533.`transforms(array $params = [])` 534**** 535[source,php] 536---- 537/* 538$params['transform_id'] = (string) The id of the transform for which to get stats. '_all' or '*' implies all transforms 539$params['from'] = (int) skips a number of transform configs, defaults to 0 540$params['size'] = (int) specifies a max number of transforms to get, defaults to 100 541$params['allow_no_match'] = (boolean) Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified) 542$params['format'] = (string) a short version of the Accept header, e.g. json, yaml 543$params['h'] = (list) Comma-separated list of column names to display 544$params['help'] = (boolean) Return help information (Default = false) 545$params['s'] = (list) Comma-separated list of column names or column aliases to sort by 546$params['time'] = (enum) The unit in which to display time values (Options = d,h,m,s,ms,micros,nanos) 547$params['v'] = (boolean) Verbose mode. Display column headers (Default = false) 548*/ 549---- 550**** 551 552 553