From b49423bc13db48a6520f3181e639ca367ed4197b Mon Sep 17 00:00:00 2001 From: ikibo Date: Sat, 4 Nov 2023 12:01:03 +0200 Subject: [PATCH 01/13] Support switch_aliases in shrink action DOC. Signed-off-by: ikibo --- _im-plugin/ism/policies.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/_im-plugin/ism/policies.md b/_im-plugin/ism/policies.md index 8e873268de..b62b61d694 100644 --- a/_im-plugin/ism/policies.md +++ b/_im-plugin/ism/policies.md @@ -187,6 +187,7 @@ Allows you to reduce the number of primary shards in your indexes. With this act "my-alias": {} } ], + "switch_aliases": true, "force_unsafe": false } ``` @@ -198,6 +199,7 @@ Parameter | Description | Type | Example | Required `percentage_of_source_shards` | Percentage of the number of original primary shards to shrink. This parameter indicates the minimum percentage to use when shrinking the number of primary shards. Must be between 0.0 and 1.0, exclusive. | Percentage | `0.5` | Yes, however it cannot be used with `max_shard_size` or `num_new_shards` `target_index_name_template` | The name of the shrunken index. Accepts strings and the Mustache variables `{{ctx.index}}` and `{{ctx.indexUuid}}`. | `string` or Mustache template | `{"source": "{{ctx.index}}_shrunken"}` | No `aliases` | Aliases to add to the new index. | object | `myalias` | No, but must be an array of alias objects +`switch_aliases` | If true, copies aliases from the soure index to the taget index. If there is a name conflict with an alias from the `aliases` field, alias from the `aliases` field is used. | boolean | `true` | No. Default implicit value is `false`, so no aliases are copied by default. `force_unsafe` | If true, executes the shrink action even if there are no replicas. | boolean | `false` | No If you want to add `aliases` to the action, the parameter must include an array of [alias objects]({{site.url}}{{site.baseurl}}/api-reference/alias/). For example, From 8a6d3b107a44a92e411083d91c10a78ec0665356 Mon Sep 17 00:00:00 2001 From: Oleg Kravchuk Date: Tue, 7 Nov 2023 10:30:11 +0200 Subject: [PATCH 02/13] Update _im-plugin/ism/policies.md Co-authored-by: Heather Halter Signed-off-by: Oleg Kravchuk --- _im-plugin/ism/policies.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_im-plugin/ism/policies.md b/_im-plugin/ism/policies.md index b62b61d694..dc6e00d260 100644 --- a/_im-plugin/ism/policies.md +++ b/_im-plugin/ism/policies.md @@ -199,7 +199,7 @@ Parameter | Description | Type | Example | Required `percentage_of_source_shards` | Percentage of the number of original primary shards to shrink. This parameter indicates the minimum percentage to use when shrinking the number of primary shards. Must be between 0.0 and 1.0, exclusive. | Percentage | `0.5` | Yes, however it cannot be used with `max_shard_size` or `num_new_shards` `target_index_name_template` | The name of the shrunken index. Accepts strings and the Mustache variables `{{ctx.index}}` and `{{ctx.indexUuid}}`. | `string` or Mustache template | `{"source": "{{ctx.index}}_shrunken"}` | No `aliases` | Aliases to add to the new index. | object | `myalias` | No, but must be an array of alias objects -`switch_aliases` | If true, copies aliases from the soure index to the taget index. If there is a name conflict with an alias from the `aliases` field, alias from the `aliases` field is used. | boolean | `true` | No. Default implicit value is `false`, so no aliases are copied by default. +`switch_aliases` | If `true`, copies the aliases from the source index to the target index. If there is a name conflict with an alias from the `aliases` field, the alias from the `aliases` field is used. | Boolean | `true` | No. The default implicit value is `false`, which means no aliases are copied by default. `force_unsafe` | If true, executes the shrink action even if there are no replicas. | boolean | `false` | No If you want to add `aliases` to the action, the parameter must include an array of [alias objects]({{site.url}}{{site.baseurl}}/api-reference/alias/). For example, From f0e14bc3ffa6bb1fb3203d3173a01c0b615a1977 Mon Sep 17 00:00:00 2001 From: Oleg Kravchuk Date: Wed, 8 Nov 2023 20:48:42 +0200 Subject: [PATCH 03/13] Update _im-plugin/ism/policies.md Co-authored-by: Melissa Vagi Signed-off-by: Oleg Kravchuk --- _im-plugin/ism/policies.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_im-plugin/ism/policies.md b/_im-plugin/ism/policies.md index dc6e00d260..eee386475a 100644 --- a/_im-plugin/ism/policies.md +++ b/_im-plugin/ism/policies.md @@ -198,7 +198,7 @@ Parameter | Description | Type | Example | Required `max_shard_size` | The maximum size in bytes of a shard for the target index. | keyword | `5gb` | Yes, however it cannot be used with `num_new_shards` or `percentage_of_source_shards` `percentage_of_source_shards` | Percentage of the number of original primary shards to shrink. This parameter indicates the minimum percentage to use when shrinking the number of primary shards. Must be between 0.0 and 1.0, exclusive. | Percentage | `0.5` | Yes, however it cannot be used with `max_shard_size` or `num_new_shards` `target_index_name_template` | The name of the shrunken index. Accepts strings and the Mustache variables `{{ctx.index}}` and `{{ctx.indexUuid}}`. | `string` or Mustache template | `{"source": "{{ctx.index}}_shrunken"}` | No -`aliases` | Aliases to add to the new index. | object | `myalias` | No, but must be an array of alias objects +`aliases` | Aliases to add to the new index. | Object | `myalias` | No, but must be an array of alias objects `switch_aliases` | If `true`, copies the aliases from the source index to the target index. If there is a name conflict with an alias from the `aliases` field, the alias from the `aliases` field is used. | Boolean | `true` | No. The default implicit value is `false`, which means no aliases are copied by default. `force_unsafe` | If true, executes the shrink action even if there are no replicas. | boolean | `false` | No From 1783dac1c2efbe180403696bcee4f68dfe5fd5c6 Mon Sep 17 00:00:00 2001 From: Oleg Kravchuk Date: Wed, 8 Nov 2023 20:49:25 +0200 Subject: [PATCH 04/13] Update _im-plugin/ism/policies.md Co-authored-by: Melissa Vagi Signed-off-by: Oleg Kravchuk --- _im-plugin/ism/policies.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_im-plugin/ism/policies.md b/_im-plugin/ism/policies.md index eee386475a..7829ae88ef 100644 --- a/_im-plugin/ism/policies.md +++ b/_im-plugin/ism/policies.md @@ -200,7 +200,7 @@ Parameter | Description | Type | Example | Required `target_index_name_template` | The name of the shrunken index. Accepts strings and the Mustache variables `{{ctx.index}}` and `{{ctx.indexUuid}}`. | `string` or Mustache template | `{"source": "{{ctx.index}}_shrunken"}` | No `aliases` | Aliases to add to the new index. | Object | `myalias` | No, but must be an array of alias objects `switch_aliases` | If `true`, copies the aliases from the source index to the target index. If there is a name conflict with an alias from the `aliases` field, the alias from the `aliases` field is used. | Boolean | `true` | No. The default implicit value is `false`, which means no aliases are copied by default. -`force_unsafe` | If true, executes the shrink action even if there are no replicas. | boolean | `false` | No +`force_unsafe` | If true, executes the shrink action even if there are no replicas. | Boolean | `false` | No If you want to add `aliases` to the action, the parameter must include an array of [alias objects]({{site.url}}{{site.baseurl}}/api-reference/alias/). For example, From 25ab28c5f3ea2e31eefd5b3cbbbc2f00f0bd6927 Mon Sep 17 00:00:00 2001 From: Oleg Kravchuk Date: Wed, 8 Nov 2023 20:50:03 +0200 Subject: [PATCH 05/13] Update _im-plugin/ism/policies.md Co-authored-by: Melissa Vagi Signed-off-by: Oleg Kravchuk --- _im-plugin/ism/policies.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_im-plugin/ism/policies.md b/_im-plugin/ism/policies.md index 7829ae88ef..f8b85928f9 100644 --- a/_im-plugin/ism/policies.md +++ b/_im-plugin/ism/policies.md @@ -197,7 +197,7 @@ Parameter | Description | Type | Example | Required `num_new_shards` | The maximum number of primary shards in the shrunken index. | integer | `5` | Yes, however it cannot be used with `max_shard_size` or `percentage_of_source_shards` `max_shard_size` | The maximum size in bytes of a shard for the target index. | keyword | `5gb` | Yes, however it cannot be used with `num_new_shards` or `percentage_of_source_shards` `percentage_of_source_shards` | Percentage of the number of original primary shards to shrink. This parameter indicates the minimum percentage to use when shrinking the number of primary shards. Must be between 0.0 and 1.0, exclusive. | Percentage | `0.5` | Yes, however it cannot be used with `max_shard_size` or `num_new_shards` -`target_index_name_template` | The name of the shrunken index. Accepts strings and the Mustache variables `{{ctx.index}}` and `{{ctx.indexUuid}}`. | `string` or Mustache template | `{"source": "{{ctx.index}}_shrunken"}` | No +`target_index_name_template` | The name of the shrunken index. Accepts strings and the Mustache variables `{{ctx.index}}` and `{{ctx.indexUuid}}`. | String or Mustache template | `{"source": "{{ctx.index}}_shrunken"}` | No `aliases` | Aliases to add to the new index. | Object | `myalias` | No, but must be an array of alias objects `switch_aliases` | If `true`, copies the aliases from the source index to the target index. If there is a name conflict with an alias from the `aliases` field, the alias from the `aliases` field is used. | Boolean | `true` | No. The default implicit value is `false`, which means no aliases are copied by default. `force_unsafe` | If true, executes the shrink action even if there are no replicas. | Boolean | `false` | No From f75efb4b9c7c872d69913d5b09d086cc717d7ead Mon Sep 17 00:00:00 2001 From: ikibo Date: Wed, 8 Nov 2023 20:57:53 +0200 Subject: [PATCH 06/13] Data types in TYPE column must be capitalized Signed-off-by: ikibo --- _im-plugin/ism/policies.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_im-plugin/ism/policies.md b/_im-plugin/ism/policies.md index f8b85928f9..d8aa4656c2 100644 --- a/_im-plugin/ism/policies.md +++ b/_im-plugin/ism/policies.md @@ -194,8 +194,8 @@ Allows you to reduce the number of primary shards in your indexes. With this act Parameter | Description | Type | Example | Required :--- | :--- |:--- |:--- | -`num_new_shards` | The maximum number of primary shards in the shrunken index. | integer | `5` | Yes, however it cannot be used with `max_shard_size` or `percentage_of_source_shards` -`max_shard_size` | The maximum size in bytes of a shard for the target index. | keyword | `5gb` | Yes, however it cannot be used with `num_new_shards` or `percentage_of_source_shards` +`num_new_shards` | The maximum number of primary shards in the shrunken index. | Integer | `5` | Yes, however it cannot be used with `max_shard_size` or `percentage_of_source_shards` +`max_shard_size` | The maximum size in bytes of a shard for the target index. | Keyword | `5gb` | Yes, however it cannot be used with `num_new_shards` or `percentage_of_source_shards` `percentage_of_source_shards` | Percentage of the number of original primary shards to shrink. This parameter indicates the minimum percentage to use when shrinking the number of primary shards. Must be between 0.0 and 1.0, exclusive. | Percentage | `0.5` | Yes, however it cannot be used with `max_shard_size` or `num_new_shards` `target_index_name_template` | The name of the shrunken index. Accepts strings and the Mustache variables `{{ctx.index}}` and `{{ctx.indexUuid}}`. | String or Mustache template | `{"source": "{{ctx.index}}_shrunken"}` | No `aliases` | Aliases to add to the new index. | Object | `myalias` | No, but must be an array of alias objects From bd4d020b42602d18baa0f21f7f0b4d5e389300fc Mon Sep 17 00:00:00 2001 From: Heather Halter Date: Wed, 8 Nov 2023 11:18:24 -0800 Subject: [PATCH 07/13] Update policies.md Added tick marks to two parameters Signed-off-by: Heather Halter --- _im-plugin/ism/policies.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_im-plugin/ism/policies.md b/_im-plugin/ism/policies.md index d8aa4656c2..8fa7ede555 100644 --- a/_im-plugin/ism/policies.md +++ b/_im-plugin/ism/policies.md @@ -117,8 +117,8 @@ Reduces the number of Lucene segments by merging the segments of individual shar Parameter | Description | Type | Required :--- | :--- |:--- |:--- | `max_num_segments` | The number of segments to reduce the shard to. | `number` | Yes -wait_for_completion | Boolean | When set to `false`, the request returns immediately instead of after the operation is finished. To monitor the operation status, use the [Tasks API]({{site.url}}{{site.baseurl}}/api-reference/tasks/) with the task ID returned by the request. Default is `true`. -task_execution_timeout | Time | The explicit task execution timeout. Only useful when wait_for_completion is set to `false`. Default is `1h`. | No +`wait_for_completion` | Boolean | When set to `false`, the request returns immediately instead of after the operation is finished. To monitor the operation status, use the [Tasks API]({{site.url}}{{site.baseurl}}/api-reference/tasks/) with the task ID returned by the request. Default is `true`. +`task_execution_timeout` | Time | The explicit task execution timeout. Only useful when wait_for_completion is set to `false`. Default is `1h`. | No ```json { From be056c65a4db4168ea255fe9af2173bbe706ed52 Mon Sep 17 00:00:00 2001 From: Heather Halter Date: Thu, 9 Nov 2023 10:06:38 -0800 Subject: [PATCH 08/13] Update _im-plugin/ism/policies.md Co-authored-by: Melissa Vagi Signed-off-by: Heather Halter --- _im-plugin/ism/policies.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_im-plugin/ism/policies.md b/_im-plugin/ism/policies.md index 8fa7ede555..03d82e9592 100644 --- a/_im-plugin/ism/policies.md +++ b/_im-plugin/ism/policies.md @@ -118,7 +118,7 @@ Parameter | Description | Type | Required :--- | :--- |:--- |:--- | `max_num_segments` | The number of segments to reduce the shard to. | `number` | Yes `wait_for_completion` | Boolean | When set to `false`, the request returns immediately instead of after the operation is finished. To monitor the operation status, use the [Tasks API]({{site.url}}{{site.baseurl}}/api-reference/tasks/) with the task ID returned by the request. Default is `true`. -`task_execution_timeout` | Time | The explicit task execution timeout. Only useful when wait_for_completion is set to `false`. Default is `1h`. | No +`task_execution_timeout` | Time | The explicit task execution timeout. Only useful when `wait_for_completion` is set to `false`. Default is `1h`. | No ```json { From 212a8b92005b8f4ede0a1ffe78931009866de9d8 Mon Sep 17 00:00:00 2001 From: Heather Halter Date: Thu, 9 Nov 2023 10:07:15 -0800 Subject: [PATCH 09/13] Update _im-plugin/ism/policies.md Co-authored-by: Melissa Vagi Signed-off-by: Heather Halter --- _im-plugin/ism/policies.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_im-plugin/ism/policies.md b/_im-plugin/ism/policies.md index 03d82e9592..6477c21c81 100644 --- a/_im-plugin/ism/policies.md +++ b/_im-plugin/ism/policies.md @@ -194,7 +194,7 @@ Allows you to reduce the number of primary shards in your indexes. With this act Parameter | Description | Type | Example | Required :--- | :--- |:--- |:--- | -`num_new_shards` | The maximum number of primary shards in the shrunken index. | Integer | `5` | Yes, however it cannot be used with `max_shard_size` or `percentage_of_source_shards` +`num_new_shards` | The maximum number of primary shards in the shrunken index. | Integer | `5` | Yes. It, however, cannot be used with `max_shard_size` or `percentage_of_source_shards`. `max_shard_size` | The maximum size in bytes of a shard for the target index. | Keyword | `5gb` | Yes, however it cannot be used with `num_new_shards` or `percentage_of_source_shards` `percentage_of_source_shards` | Percentage of the number of original primary shards to shrink. This parameter indicates the minimum percentage to use when shrinking the number of primary shards. Must be between 0.0 and 1.0, exclusive. | Percentage | `0.5` | Yes, however it cannot be used with `max_shard_size` or `num_new_shards` `target_index_name_template` | The name of the shrunken index. Accepts strings and the Mustache variables `{{ctx.index}}` and `{{ctx.indexUuid}}`. | String or Mustache template | `{"source": "{{ctx.index}}_shrunken"}` | No From 0c7bccdff4b22698ba577d144c85ed51ee5c23a1 Mon Sep 17 00:00:00 2001 From: Heather Halter Date: Thu, 9 Nov 2023 10:07:43 -0800 Subject: [PATCH 10/13] Update _im-plugin/ism/policies.md Co-authored-by: Melissa Vagi Signed-off-by: Heather Halter --- _im-plugin/ism/policies.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_im-plugin/ism/policies.md b/_im-plugin/ism/policies.md index 6477c21c81..3055912045 100644 --- a/_im-plugin/ism/policies.md +++ b/_im-plugin/ism/policies.md @@ -195,7 +195,7 @@ Allows you to reduce the number of primary shards in your indexes. With this act Parameter | Description | Type | Example | Required :--- | :--- |:--- |:--- | `num_new_shards` | The maximum number of primary shards in the shrunken index. | Integer | `5` | Yes. It, however, cannot be used with `max_shard_size` or `percentage_of_source_shards`. -`max_shard_size` | The maximum size in bytes of a shard for the target index. | Keyword | `5gb` | Yes, however it cannot be used with `num_new_shards` or `percentage_of_source_shards` +`max_shard_size` | The maximum size in bytes of a shard for the target index. | Keyword | `5gb` | Yes, however, it cannot be used with `num_new_shards` or `percentage_of_source_shards`. `percentage_of_source_shards` | Percentage of the number of original primary shards to shrink. This parameter indicates the minimum percentage to use when shrinking the number of primary shards. Must be between 0.0 and 1.0, exclusive. | Percentage | `0.5` | Yes, however it cannot be used with `max_shard_size` or `num_new_shards` `target_index_name_template` | The name of the shrunken index. Accepts strings and the Mustache variables `{{ctx.index}}` and `{{ctx.indexUuid}}`. | String or Mustache template | `{"source": "{{ctx.index}}_shrunken"}` | No `aliases` | Aliases to add to the new index. | Object | `myalias` | No, but must be an array of alias objects From 0abbb10cdf3ff4bc9c841ffb64c5bb3619ead9cc Mon Sep 17 00:00:00 2001 From: Heather Halter Date: Thu, 9 Nov 2023 10:07:57 -0800 Subject: [PATCH 11/13] Update _im-plugin/ism/policies.md Co-authored-by: Melissa Vagi Signed-off-by: Heather Halter --- _im-plugin/ism/policies.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_im-plugin/ism/policies.md b/_im-plugin/ism/policies.md index 3055912045..57ace958d9 100644 --- a/_im-plugin/ism/policies.md +++ b/_im-plugin/ism/policies.md @@ -198,7 +198,7 @@ Parameter | Description | Type | Example | Required `max_shard_size` | The maximum size in bytes of a shard for the target index. | Keyword | `5gb` | Yes, however, it cannot be used with `num_new_shards` or `percentage_of_source_shards`. `percentage_of_source_shards` | Percentage of the number of original primary shards to shrink. This parameter indicates the minimum percentage to use when shrinking the number of primary shards. Must be between 0.0 and 1.0, exclusive. | Percentage | `0.5` | Yes, however it cannot be used with `max_shard_size` or `num_new_shards` `target_index_name_template` | The name of the shrunken index. Accepts strings and the Mustache variables `{{ctx.index}}` and `{{ctx.indexUuid}}`. | String or Mustache template | `{"source": "{{ctx.index}}_shrunken"}` | No -`aliases` | Aliases to add to the new index. | Object | `myalias` | No, but must be an array of alias objects +`aliases` | Aliases to add to the new index. | Object | `myalias` | No. It must be an array of alias objects. `switch_aliases` | If `true`, copies the aliases from the source index to the target index. If there is a name conflict with an alias from the `aliases` field, the alias from the `aliases` field is used. | Boolean | `true` | No. The default implicit value is `false`, which means no aliases are copied by default. `force_unsafe` | If true, executes the shrink action even if there are no replicas. | Boolean | `false` | No From e7e99b8ba635c59cfc48d40420cec102e87f86f3 Mon Sep 17 00:00:00 2001 From: Heather Halter Date: Thu, 9 Nov 2023 10:08:31 -0800 Subject: [PATCH 12/13] Update _im-plugin/ism/policies.md Co-authored-by: Melissa Vagi Signed-off-by: Heather Halter --- _im-plugin/ism/policies.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_im-plugin/ism/policies.md b/_im-plugin/ism/policies.md index 57ace958d9..76b14c29f2 100644 --- a/_im-plugin/ism/policies.md +++ b/_im-plugin/ism/policies.md @@ -199,7 +199,7 @@ Parameter | Description | Type | Example | Required `percentage_of_source_shards` | Percentage of the number of original primary shards to shrink. This parameter indicates the minimum percentage to use when shrinking the number of primary shards. Must be between 0.0 and 1.0, exclusive. | Percentage | `0.5` | Yes, however it cannot be used with `max_shard_size` or `num_new_shards` `target_index_name_template` | The name of the shrunken index. Accepts strings and the Mustache variables `{{ctx.index}}` and `{{ctx.indexUuid}}`. | String or Mustache template | `{"source": "{{ctx.index}}_shrunken"}` | No `aliases` | Aliases to add to the new index. | Object | `myalias` | No. It must be an array of alias objects. -`switch_aliases` | If `true`, copies the aliases from the source index to the target index. If there is a name conflict with an alias from the `aliases` field, the alias from the `aliases` field is used. | Boolean | `true` | No. The default implicit value is `false`, which means no aliases are copied by default. +`switch_aliases` | If `true`, copies the aliases from the source index to the target index. If there is a name conflict with an alias from the `aliases` field, the alias in the `aliases` field is used instead of the name. | Boolean | `true` | No. The default implicit value is `false`, which means no aliases are copied by default. `force_unsafe` | If true, executes the shrink action even if there are no replicas. | Boolean | `false` | No If you want to add `aliases` to the action, the parameter must include an array of [alias objects]({{site.url}}{{site.baseurl}}/api-reference/alias/). For example, From 1ed5c6a851bbe9ebf989c4af099800324aef1d79 Mon Sep 17 00:00:00 2001 From: Heather Halter Date: Thu, 9 Nov 2023 10:08:45 -0800 Subject: [PATCH 13/13] Update _im-plugin/ism/policies.md Co-authored-by: Melissa Vagi Signed-off-by: Heather Halter --- _im-plugin/ism/policies.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_im-plugin/ism/policies.md b/_im-plugin/ism/policies.md index 76b14c29f2..de6a8bdc16 100644 --- a/_im-plugin/ism/policies.md +++ b/_im-plugin/ism/policies.md @@ -200,7 +200,7 @@ Parameter | Description | Type | Example | Required `target_index_name_template` | The name of the shrunken index. Accepts strings and the Mustache variables `{{ctx.index}}` and `{{ctx.indexUuid}}`. | String or Mustache template | `{"source": "{{ctx.index}}_shrunken"}` | No `aliases` | Aliases to add to the new index. | Object | `myalias` | No. It must be an array of alias objects. `switch_aliases` | If `true`, copies the aliases from the source index to the target index. If there is a name conflict with an alias from the `aliases` field, the alias in the `aliases` field is used instead of the name. | Boolean | `true` | No. The default implicit value is `false`, which means no aliases are copied by default. -`force_unsafe` | If true, executes the shrink action even if there are no replicas. | Boolean | `false` | No +`force_unsafe` | If `true`, shrinks the index even if it has no replicas. | Boolean | `false` | No If you want to add `aliases` to the action, the parameter must include an array of [alias objects]({{site.url}}{{site.baseurl}}/api-reference/alias/). For example,