diff --git a/_api-reference/cat/cat-aliases.md b/_api-reference/cat/cat-aliases.md index 950d497351..98c9ce6ac9 100644 --- a/_api-reference/cat/cat-aliases.md +++ b/_api-reference/cat/cat-aliases.md @@ -16,20 +16,32 @@ has_children: false The CAT aliases operation lists the mapping of aliases to indexes, plus routing and filtering information. -## Path and HTTP methods - + +## Paths and HTTP methods ```json -GET _cat/aliases/ -GET _cat/aliases +GET /_cat/aliases +GET /_cat/aliases/{name} ``` -{% include copy-curl.html %} + + ## Query parameters - Parameter | Type | Description :--- | :--- | :--- -local | Boolean | Whether to return information from the local node only instead of from the cluster manager node. Default is `false`. -expand_wildcards | Enum | Expands wildcard expressions to concrete indexes. Combine multiple values with commas. Supported values are `all`, `open`, `closed`, `hidden`, and `none`. Default is `open`. +`expand_wildcards` | String / String / String / String / List | Whether to expand wildcard expression to concrete indexes that are open, closed or both. +`format` | String | A short version of the Accept header (for example, `json`, `yaml`). +`h` | List | Comma-separated list of column names to display. +`help` | Boolean | Return help information. +`local` | Boolean | Return local information, do not retrieve the state from cluster-manager node. +`s` | List | Comma-separated list of column names or column aliases to sort by. +`v` | Boolean | Verbose mode. Display column headers. + ## Example requests diff --git a/_api-reference/cat/cat-allocation.md b/_api-reference/cat/cat-allocation.md index a57c861a4b..c5c9af23f3 100644 --- a/_api-reference/cat/cat-allocation.md +++ b/_api-reference/cat/cat-allocation.md @@ -15,20 +15,36 @@ has_children: false The CAT allocation operation lists the allocation of disk space for indexes and the number of shards on each node. -## Path and HTTP methods - + +## Paths and HTTP methods ```json -GET _cat/allocation?v -GET _cat/allocation/ +GET /_cat/allocation +GET /_cat/allocation/{node_id} ``` + + -## Query parameters + +## Query parameters Parameter | Type | Description :--- | :--- | :--- -bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/). -local | Boolean | Whether to return information from the local node only instead of from the cluster manager node. Default is `false`. -cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds. +`bytes` | String | The unit used to display byte values. +`cluster_manager_timeout` | String | Operation timeout for connection to cluster-manager node. +`format` | String | A short version of the Accept header (for example, `json`, `yaml`). +`h` | List | Comma-separated list of column names to display. +`help` | Boolean | Return help information. +`local` | Boolean | Return local information, do not retrieve the state from cluster-manager node. +`s` | List | Comma-separated list of column names or column aliases to sort by. +`v` | Boolean | Verbose mode. Display column headers. +`master_timeout`
_DEPRECATED_ | String | _(Deprecated since 2.0: To promote inclusive language, use `cluster_manager_timeout` instead.)_ Operation timeout for connection to cluster-manager node. + ## Example requests diff --git a/_api-reference/cat/cat-cluster_manager.md b/_api-reference/cat/cat-cluster_manager.md index 1b75074e12..fdb82cfe32 100644 --- a/_api-reference/cat/cat-cluster_manager.md +++ b/_api-reference/cat/cat-cluster_manager.md @@ -15,11 +15,32 @@ has_children: false The CAT cluster manager operation lists information that helps identify the elected cluster manager node. -## Path and HTTP methods - + +## Paths and HTTP methods ```json -GET _cat/cluster_manager +GET /_cat/cluster_manager ``` + + + +## Query parameters +Parameter | Type | Description +:--- | :--- | :--- +`cluster_manager_timeout` | String | Operation timeout for connection to cluster-manager node. +`format` | String | A short version of the Accept header (for example, `json`, `yaml`). +`h` | List | Comma-separated list of column names to display. +`help` | Boolean | Return help information. +`local` | Boolean | Return local information, do not retrieve the state from cluster-manager node. +`s` | List | Comma-separated list of column names or column aliases to sort by. +`v` | Boolean | Verbose mode. Display column headers. +`master_timeout`
_DEPRECATED_ | String | _(Deprecated since 2.0: To promote inclusive language, use `cluster_manager_timeout` instead.)_ Operation timeout for connection to cluster-manager node. + ## Query parameters