common-parms.asciidoc 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  1. tag::bytes[]
  2. `bytes`::
  3. (Optional, <<byte-units,byte size units>>) Unit used to display byte values.
  4. end::bytes[]
  5. tag::cat-h[]
  6. `h`::
  7. (Optional, string) Comma-separated list of column names to display.
  8. end::cat-h[]
  9. tag::flat-settings[]
  10. `flat_settings`::
  11. (Optional, boolean) If `true`, returns settings in flat format. Defaults to
  12. `false`.
  13. end::flat-settings[]
  14. tag::help[]
  15. `help`::
  16. (Optional, boolean) If `true`, the response returns help information. Defaults
  17. to `false`.
  18. end::help[]
  19. tag::http-format[]
  20. `format`::
  21. (Optional, string) Short version of the
  22. https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html[HTTP accept header].
  23. Valid values include JSON, YAML, etc.
  24. end::http-format[]
  25. tag::include-unloaded-segments[]
  26. `include_unloaded_segments`::
  27. (Optional, boolean) If `true`, the response includes information from segments
  28. that are **not** loaded into memory. Defaults to `false`.
  29. end::include-unloaded-segments[]
  30. tag::index[]
  31. `{index}`::
  32. (Optional, string) Comma-separated list or wildcard expression of index names
  33. used to limit the request.
  34. end::index[]
  35. tag::local[]
  36. `local`::
  37. (Optional, boolean) If `true`, the request retrieves information from the local
  38. node only. Defaults to `false`, which means information is retrieved from
  39. the master node.
  40. end::local[]
  41. tag::name[]
  42. `{name}`::
  43. (Optional, string) Comma-separated list of alias names to return.
  44. end::name[]
  45. tag::node-id[]
  46. `{node_id}`::
  47. (Optional, string) Comma-separated list of node IDs or names used to limit
  48. returned information.
  49. end::node-id[]
  50. tag::cat-s[]
  51. `s`::
  52. (Optional, string) Comma-separated list of column names or column aliases used
  53. to sort the response.
  54. end::cat-s[]
  55. tag::cat-v[]
  56. `v`::
  57. (Optional, boolean) If `true`, the response includes column headings. Defaults
  58. to `false`.
  59. end::cat-v[]
  60. tag::timeoutparms[]
  61. `timeout`::
  62. (Optional, <<time-units, time units>>) Specifies the period of time to wait for
  63. a response. If no response is received before the timeout expires, the request
  64. fails and returns an error. Defaults to `30s`.
  65. tag::master-timeout[]
  66. `master_timeout`::
  67. (Optional, <<time-units, time units>>) Specifies the period of time to wait for
  68. a connection to the master node. If no response is received before the timeout
  69. expires, the request fails and returns an error. Defaults to `30s`.
  70. end::master-timeout[]
  71. end::timeoutparms[]