Path parameters
-
Identifier for the Deployment
Query parameters
-
show_security boolean
Whether to include the Elasticsearch 2.x security information in the response - can be large per cluster and also include credentials
Default value is
false
. -
show_metadata boolean
Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials
Default value is
false
. -
show_plans boolean
Whether to include the full current and pending plan information in the response - can be large per cluster
Default value is
true
. -
show_plan_logs boolean
Whether to include with the current and pending plan information the attempt log - can be very large per cluster
Default value is
false
. -
show_plan_history boolean
Whether to include the plan history with the current and pending plan information. The results can be very large per cluster. By default, if a given resource kind (e.g. Elasticsearch, Kibana, etc.) has more than 100 plans (which should be very rare, most likely caused by a bug) only 100 plans are returned for the given resource type: The first 10 plans, and the last 90 plans for that resource type. If ALL of the plans are desired, pass the
force_all_plan_history
parameter with a value oftrue
.Default value is
false
. -
show_plan_defaults boolean
If showing plans, whether to show values that are left at their default value (less readable but more informative)
Default value is
false
. -
convert_legacy_plans boolean
If showing plans, whether to leave pre-2.0.0 plans in their legacy format (the default), or whether to update them to 2.0.x+ format (if 'true')
Default value is
false
. -
show_system_alerts integer
Number of system alerts (such as forced restarts due to memory limits) to be included in the response - can be large per cluster. Negative numbers or 0 will not return field.
Default value is
0
. -
show_settings boolean
Whether to show cluster settings in the response.
Default value is
false
. -
show_instance_configurations boolean
If true, will return details for each instance configuration referenced by the deployment.
Default value is
true
. -
enrich_with_template boolean
If showing plans, whether to enrich the plan by including the missing elements from the deployment template it is based on
Default value is
true
. -
force_all_plan_history boolean
Force show the entire plan history no matter how long. As noted in the
show_plan_history
parameter description, by default, a maximum of 100 plans are shown per resource. Iftrue
, this parameter overrides the default, and ALL plans are returned. Use with care as the plan history can be VERY large. Consider pairing withshow_plan_logs=false
.Default value is
false
. -
clear_transient boolean
If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update
Default value is
false
.
Responses
-
The Deployment info response
Hide headers attributes Show headers attributes
-
x-cloud-resource-version string
The resource version, which is used to avoid update conflicts with concurrent operations
-
x-cloud-resource-created string
The date-time when the resource was created (ISO format relative to UTC)
-
The date-time when the resource was last modified (ISO format relative to UTC)
Hide response attributes Show response attributes object
-
A randomly-generated id of this Deployment
-
The name of this deployment
-
alias string
A user-defined deployment alias for user-friendly resource URLs
-
Whether the deployment is overall healthy or not (one or more of the resource info subsections will have healthy: false)
-
The Resources that belong to this Deployment
Additional properties are allowed.
Hide resources attributes Show resources attributes object
-
List of Elasticsearch resources in your Deployment
Hide elasticsearch attributes Show elasticsearch attributes object
-
The locally-unique user-specified id of a Resource
-
The randomly-generated id of a Resource
-
The region where this resource exists
-
Info for the resource.
Additional properties are allowed.
Hide info attributes Show info attributes object
-
The id of the cluster
-
The name of the cluster
-
deployment_id string
The id of the deployment that this Elasticsearch belongs to.
-
Whether the cluster is healthy or not (one or more of the info subsections will have healthy: false)
-
Cluster status
Values are
initializing
,stopping
,stopped
,rebooting
,restarting
,reconfiguring
, orstarted
. -
Information about the current, pending, and past Elasticsearch cluster plans.
Additional properties are allowed.
Hide plan_info attributes Show plan_info attributes object
-
Whether the plan situation is healthy (if unhealthy, means the last plan attempt failed)
-
current object
Information about the Elasticsearch cluster plan.
Additional properties are allowed.
Hide current attributes Show current attributes object
-
plan_attempt_id string
A UUID for each plan attempt
-
plan_attempt_name string
A human readable name for each plan attempt, only populated when retrieving plan histories
-
Either the plan ended successfully, or is not yet completed (and no errors have occurred)
-
attempt_start_time string(date-time)
When this plan attempt (ie to apply the plan to the cluster) started (ISO format in UTC)
-
attempt_end_time string(date-time)
If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)
-
plan_end_time string(date-time)
If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)
-
plan object
The plan for building this Elasticsearch cluster
Additional properties are allowed.
Hide plan attributes Show plan attributes object
-
Hide cluster_topology attributes Show cluster_topology attributes object
-
id string
Unique identifier of this topology element
-
node_type object
Controls the combinations of Elasticsearch node types. TIP: By default, the Elasticsearch node is master eligible, can hold data, and run ingest pipelines. WARNING: Do not set for tiebreaker topologies.
Additional properties are allowed.
Hide node_type attributes Show node_type attributes object
-
master boolean
Defines whether this node can be elected master (default: false)
-
data boolean
Defines whether this node can hold data (default: false)
-
ingest boolean
Defines whether this node can run an ingest pipeline (default: false)
-
ml boolean
Defines whether this node can run ml jobs, valid only for versions 5.4.0 or greater (default: false)
-
-
node_roles array[string]
The list of node roles for this topology element (ES version >= 7.10). Allowable values are: master, ingest, ml, data_hot, data_content, data_warm, data_cold, data_frozen, remote_cluster_client, transform
Values are
master
,ingest
,ml
,data_hot
,data_content
,data_warm
,data_cold
,data_frozen
,remote_cluster_client
, ortransform
. -
memory_per_node integer(int32)
The memory capacity in MB for each node of this type built in each zone.
-
node_count_per_zone integer(int32)
The number of nodes of this type that are allocated within each zone. (i.e. total capacity per zone =
node_count_per_zone
*memory_per_node
in MB). Cannot be set for tiebreaker topologies. For dedicated master nodes, must be 1 if an entry exists. -
zone_count integer(int32)
The default number of zones in which data nodes will be placed
-
elasticsearch object
The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.
Additional properties are allowed.
Hide elasticsearch attributes Show elasticsearch attributes object
-
version string
The version of the Elasticsearch cluster (must be one of the ECE supported versions). Currently cannot be different across the topology (and is generally specified in the globals). Defaults to the latest version if not specified.
-
docker_image string
A docker URI that allows overriding of the default docker image specified for this version
-
system_settings object
A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use
ElasticsearchSystemSettings
withuser_settings_override*
anduser_settings*
.Additional properties are allowed.
Hide system_settings attributes Show system_settings attributes object
-
scripting object
Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON.
Additional properties are allowed.
Hide scripting attributes Show scripting attributes object
-
painless_enabled boolean
(5.x+ only) If enabled (the default) then the painless scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.painless.[file|stored|inline]')
-
mustache_enabled boolean
(5.x+ only) If enabled (the default) then the mustache scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.mustache.[file|stored|inline]')
-
expressions_enabled boolean
(5.x+ only) If enabled (the default) then the expressions scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.expression.[file|stored|inline]')
-
stored object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide stored attributes Show stored attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
file object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide file attributes Show file attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
inline object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide inline attributes Show inline attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
-
reindex_whitelist array[string]
Limits remote Elasticsearch clusters that can be used as the source for '_reindex' API commands
-
auto_create_index boolean
If true (the default), then any write operation on an index that does not currently exist will create it. NOTES: (Corresponds to the parameter 'action.auto_create_index')
-
enable_close_index boolean
Defaults to false on versions <= 7.2.0, true otherwise. If false, then the API commands to close indices are disabled. This is important because Elasticsearch does not snapshot or migrate close indices on versions under 7.2.0, therefore standard Elastic Cloud configuration operations will cause irretrievable loss of indices' data. NOTES: (Corresponds to the parameter 'cluster.indices.close.enable')
-
destructive_requires_name boolean
If true (default is false) then the index deletion API will not support wildcards or '_all'. NOTES: (Corresponds to the parameter 'action.destructive_requires_name')
-
watcher_trigger_engine string
The trigger engine for Watcher, defaults to 'scheduler' - see the xpack documentation for more information. NOTES: (Corresponds to the parameter '(xpack.)watcher.trigger.schedule.engine', depending on version. Ignored from 6.x onwards.)
-
default_shards_per_index integer(int32)
(2.x only - to get the same result in 5.x template mappings must be used) Sets the default number of shards per index, defaulting to 1 if not specified. (Corresponds to the parameter 'index.number_of_shards' in 2.x, not supported in 5.x)
-
monitoring_collection_interval integer(int32)
The default interval at which monitoring information from the cluster if collected, if monitoring is enabled. NOTES: (Corresponds to the parameter 'marvel.agent.interval' in 2.x and 'xpack.monitoring.collection.interval' in 5.x)
-
monitoring_history_duration string
The duration for which monitoring history is stored (format '(NUMBER)d' eg '3d' for 3 days). NOTES: ('Corresponds to the parameter xpack.monitoring.history.duration' in 5.x, defaults to '7d')
-
-
user_settings_json object
An arbitrary JSON object allowing cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
Additional properties are allowed.
-
user_settings_yaml string
An arbitrary YAML object allowing cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
-
user_settings_override_json object
An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
Additional properties are allowed.
-
user_settings_override_yaml string
An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
-
enabled_built_in_plugins array[string]
A list of plugin names from the Elastic-supported subset that are bundled with the version images. NOTES: (Users should consult the Elastic stack objects to see what plugins are available, this is currently only available from the UI)
-
user_plugins array[object]
A list of admin-uploaded plugin objects that are available for this user.
Hide user_plugins attributes Show user_plugins attributes object
-
The name of the plugin
-
The URL of the plugin (must be accessible from the ECE infrastructure)
-
The supported Elasticsearch version (must match the version in the plan)
-
-
user_bundles array[object]
A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user.
Hide user_bundles attributes Show user_bundles attributes object
-
The name of the bundle
-
The URL of the bundle, which must be accessible from the ECE infrastructure. This URL could be cached by platform, make sure to change it when updating the bundle
-
The supported Elasticsearch version (must match the version in the plan)
-
-
curation object
Defines the index curation routing for the cluster
Additional properties are allowed.
Hide curation attributes Show curation attributes object
-
The source instance configuration
-
The destination instance configuration
-
-
node_attributes object
Defines the Elasticsearch node attributes for the instances in the topology
Hide node_attributes attribute Show node_attributes attribute object
-
-
instance_configuration_id string
Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
-
instance_configuration_version integer(int32)
The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.
-
size object
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
Additional properties are allowed.
-
autoscaling_min object
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
Additional properties are allowed.
-
autoscaling_max object
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
Additional properties are allowed.
-
An arbitrary JSON object overriding the default autoscaling policy. Don't set unless you really know what you are doing.
Additional properties are allowed.
-
topology_element_control object
Controls for the topology element. Only used as part of the deployment template. Ignored if included as part of a deployment.
Additional properties are allowed.
Hide topology_element_control attribute Show topology_element_control attribute object
-
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
Additional properties are allowed.
-
-
autoscaling_tier_override boolean
Set to true to enable autoscaling for this topology element, even if the cluster-level 'autoscaling_enabled' field is false. Note that 'autoscaling_tier_override' cannot be set to false if cluster-level 'autoscaling_enabled' is true. Currently only supported for the 'ml' tier
-
-
The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.
Additional properties are allowed.
Hide elasticsearch attributes Show elasticsearch attributes object
-
version string
The version of the Elasticsearch cluster (must be one of the ECE supported versions). Currently cannot be different across the topology (and is generally specified in the globals). Defaults to the latest version if not specified.
-
docker_image string
A docker URI that allows overriding of the default docker image specified for this version
-
system_settings object
A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use
ElasticsearchSystemSettings
withuser_settings_override*
anduser_settings*
.Additional properties are allowed.
Hide system_settings attributes Show system_settings attributes object
-
scripting object
Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON.
Additional properties are allowed.
Hide scripting attributes Show scripting attributes object
-
painless_enabled boolean
(5.x+ only) If enabled (the default) then the painless scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.painless.[file|stored|inline]')
-
mustache_enabled boolean
(5.x+ only) If enabled (the default) then the mustache scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.mustache.[file|stored|inline]')
-
expressions_enabled boolean
(5.x+ only) If enabled (the default) then the expressions scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.expression.[file|stored|inline]')
-
stored object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide stored attributes Show stored attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
file object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide file attributes Show file attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
inline object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide inline attributes Show inline attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
-
reindex_whitelist array[string]
Limits remote Elasticsearch clusters that can be used as the source for '_reindex' API commands
-
auto_create_index boolean
If true (the default), then any write operation on an index that does not currently exist will create it. NOTES: (Corresponds to the parameter 'action.auto_create_index')
-
enable_close_index boolean
Defaults to false on versions <= 7.2.0, true otherwise. If false, then the API commands to close indices are disabled. This is important because Elasticsearch does not snapshot or migrate close indices on versions under 7.2.0, therefore standard Elastic Cloud configuration operations will cause irretrievable loss of indices' data. NOTES: (Corresponds to the parameter 'cluster.indices.close.enable')
-
destructive_requires_name boolean
If true (default is false) then the index deletion API will not support wildcards or '_all'. NOTES: (Corresponds to the parameter 'action.destructive_requires_name')
-
watcher_trigger_engine string
The trigger engine for Watcher, defaults to 'scheduler' - see the xpack documentation for more information. NOTES: (Corresponds to the parameter '(xpack.)watcher.trigger.schedule.engine', depending on version. Ignored from 6.x onwards.)
-
default_shards_per_index integer(int32)
(2.x only - to get the same result in 5.x template mappings must be used) Sets the default number of shards per index, defaulting to 1 if not specified. (Corresponds to the parameter 'index.number_of_shards' in 2.x, not supported in 5.x)
-
monitoring_collection_interval integer(int32)
The default interval at which monitoring information from the cluster if collected, if monitoring is enabled. NOTES: (Corresponds to the parameter 'marvel.agent.interval' in 2.x and 'xpack.monitoring.collection.interval' in 5.x)
-
monitoring_history_duration string
The duration for which monitoring history is stored (format '(NUMBER)d' eg '3d' for 3 days). NOTES: ('Corresponds to the parameter xpack.monitoring.history.duration' in 5.x, defaults to '7d')
-
-
user_settings_json object
An arbitrary JSON object allowing cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
Additional properties are allowed.
-
user_settings_yaml string
An arbitrary YAML object allowing cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
-
user_settings_override_json object
An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
Additional properties are allowed.
-
user_settings_override_yaml string
An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
-
enabled_built_in_plugins array[string]
A list of plugin names from the Elastic-supported subset that are bundled with the version images. NOTES: (Users should consult the Elastic stack objects to see what plugins are available, this is currently only available from the UI)
-
user_plugins array[object]
A list of admin-uploaded plugin objects that are available for this user.
Hide user_plugins attributes Show user_plugins attributes object
-
The name of the plugin
-
The URL of the plugin (must be accessible from the ECE infrastructure)
-
The supported Elasticsearch version (must match the version in the plan)
-
-
user_bundles array[object]
A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user.
Hide user_bundles attributes Show user_bundles attributes object
-
The name of the bundle
-
The URL of the bundle, which must be accessible from the ECE infrastructure. This URL could be cached by platform, make sure to change it when updating the bundle
-
The supported Elasticsearch version (must match the version in the plan)
-
-
curation object
Defines the index curation routing for the cluster
Additional properties are allowed.
Hide curation attributes Show curation attributes object
-
The source instance configuration
-
The destination instance configuration
-
-
node_attributes object
Defines the Elasticsearch node attributes for the instances in the topology
Hide node_attributes attribute Show node_attributes attribute object
-
-
deployment_template object
Documents which deployment template was used in the creation of this plan
Additional properties are allowed.
-
transient object
Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Elasticsearch settings.
Additional properties are allowed.
Hide transient attributes Show transient attributes object
-
strategy object
The options for performing a plan change. Specify only one property each time. The default is
grow_and_shrink
.Additional properties are allowed.
Hide strategy attributes Show strategy attributes object
-
rolling object
Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.
Additional properties are allowed.
Hide rolling attributes Show rolling attributes object
-
group_by string
Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade
-
allow_inline_resize boolean
Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing
-
skip_synced_flush boolean
Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy
-
shard_init_wait_time integer(int64)
The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)
-
-
grow_and_shrink object
A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances.
GrowShrinkStrategyConfig
is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.Additional properties are allowed.
-
rolling_grow_and_shrink object
A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.
Additional properties are allowed.
-
autodetect object
A strategy that lets constructor choose the most optimal way to execute the plan.
Additional properties are allowed.
-
-
plan_configuration object
The configuration settings for the timeout and fallback parameters.
Additional properties are allowed.
Hide plan_configuration attributes Show plan_configuration attributes object
-
timeout integer(int64)
The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB). NOTES: A 3 zone cluster with 2 nodes of 2048 each would have a timeout of 4*2048=8192 seconds. Timeout does not include time required to run rollback actions.
-
calm_wait_time integer(int64)
This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
-
move_instances array[object]
Hide move_instances attributes Show move_instances attributes object
-
The instance id that is going to be moved
-
to array[string]
An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
-
instance_down boolean
Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)
-
-
move_allocators array[object]
Hide move_allocators attributes Show move_allocators attributes object
-
The allocator id off which all instances in the cluster should be moved
-
to array[string]
An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
-
allocator_down boolean
Tells the infrastructure that all instances on the allocator should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will auto-decide (currently: will treat the allocator as up)
-
-
move_only boolean
If true (default: false) only move_instances and move_allocators instructions will be executed, all other changes will be ignored
-
reallocate_instances boolean
If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created
-
preferred_allocators array[string]
List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)
-
preferred_allocator_tags object
Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators
Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
-
skip_snapshot boolean
If true (default: false), does not take (or require) a successful snapshot to be taken before performing any potentially destructive changes to this cluster
-
max_snapshot_attempts integer(int32)
If taking a snapshot (ie unless 'skip_snapshots': true) then will retry on failure at most this number of times (default: 5)
-
max_snapshot_age integer(int64)
When you take a snapshot and 'skip_snapshots' is false, specifies the maximum age in seconds of the most recent snapshot before a new snapshot is created. Default is 300
-
extended_maintenance boolean
If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster
-
cluster_reboot string
Set to 'forced' to force a reboot as part of the upgrade plan. NOTES: (ie taking an existing plan and leaving it alone except for setting 'transient.plan_configuration.cluster_reboot': 'forced' will reboot the cluster)
Value is
forced
. -
override_failsafe boolean
If false (the default) then the plan will fail out if it believes the requested sequence of operations can result in data loss - this flag will override some of these restraints
-
skip_data_migration boolean
If true (default: false) then the plan will not wait for data to be migrated from old instances to new instances before continuing the plan (potentially deleting the old instances and losing data)
-
skip_upgrade_checker boolean
If false, the cluster is checked for issues that should be resolved before migration (eg contains old Lucene segments), if true this is bypassed
-
skip_post_upgrade_steps boolean
If false (the default), the cluster will run (currently) 2.x->5.x operations for any plan change ending with a 5.x cluster (eg apply a cluster license, ensure Monitoring is configured)
-
skip_snapshot_post_major_upgrade boolean
If false (the default), the cluster will perform a snapshot after a major version upgrade takes place
-
-
restore_snapshot object
Restores a snapshot from a local or remote repository.
Additional properties are allowed.
Hide restore_snapshot attributes Show restore_snapshot attributes object
-
repository_name string
If specified, contains the name of the snapshot repository - else will default to the Elastic Cloud system repo ('found-snapshots')
-
The name of the snapshot to restore. Use '__latest_success__' to get the most recent snapshot from the specified repository
-
repository_config object
Raw remote snapshot restore settings. Do not send this if you are sending source_cluster_id
Additional properties are allowed.
Hide repository_config attribute Show repository_config attribute object
-
raw_settings object
The remote snapshot settings raw JSON - see the Elasticsearch '_snapshot' documentation for more details on supported formats
Additional properties are allowed.
-
-
restore_payload object
The configuration for the restore command, such as which indices you want to restore.
Additional properties are allowed.
Hide restore_payload attributes Show restore_payload attributes object
-
indices array[string]
The list of indices to restore (supports +ve and -ve selection and wildcarding - see the default Elasticsearch index format documentation)
-
raw_settings object
This JSON object (merged with the 'indices' field (if present) is passed untouched into the restore command - see the Elasticsearch '_snapshot' documentation for more details on supported formats
Additional properties are allowed.
-
-
strategy string
The restore strategy to use. Defaults to a full restore. Partial restore will attempt to restore unavailable indices only
Values are
partial
,full
, orrecovery
. -
source_cluster_id string
If specified, contains the name of the source cluster id. Do not send this if you are sending repository_config
-
-
remote_clusters object
The list of resources that will be configured as remote clusters
Additional properties are allowed.
Hide remote_clusters attribute Show remote_clusters attribute object
-
The remote resources
Hide resources attributes Show resources attributes object
-
The id of the deployment
-
The locally-unique user-specified id of an Elasticsearch Resource
-
The alias for this remote cluster. Aliases must only contain letters, digits, dashes and underscores
-
skip_unavailable boolean
If true, skip this cluster during search if it is disconnected. Default: false
-
info object
Information about a Remote Cluster.
Additional properties are allowed.
Hide info attributes Show info attributes object
-
Whether or not the remote cluster is healthy
-
Whether or not there is at least one connection to the remote cluster.
-
Whether or not the remote cluster version is compatible with this cluster version.
-
Whether or not the remote cluster is trusted by this cluster.
-
Whether or not the remote cluster trusts this cluster back.
-
-
-
-
cluster_settings_json object
If specified, contains transient settings to be applied to an Elasticsearch cluster during changes,default values shown below applied. These can be overridden by specifying them in the map (or null to unset). Additional settings can also be set. Settings will be cleared after the plan has finished. If not specified, no settings will be applied. NOTE: These settings are only explicitly cleared for 5.x+ clusters, they must be hand-reset to their defaults in 2.x- (or a cluster reboot will clear them).
- indices.store.throttle.max_bytes_per_sec: 120Mb
- indices.recovery.max_bytes_per_sec: 120Mb
- cluster.routing.allocation.cluster_concurrent_rebalance: 5
- cluster.routing.allocation.node_initial_primaries_recoveries: 5
- cluster.routing.allocation.node_concurrent_incoming_recoveries: 5 For version 8.1 and later no defaults are provided through this mechanism, but instead hardware dependent settings are provided to each instance.
Additional properties are allowed.
-
-
autoscaling_enabled boolean
Enable autoscaling for this Elasticsearch cluster.
-
-
Hide plan_attempt_log attributes Show plan_attempt_log attributes object
-
ID of current step
-
When the step started (ISO format in UTC)
-
completed string(date-time)
When the step completed (ISO format in UTC)
-
duration_in_millis integer(int64)
The duration of the step in MS
-
The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)
Values are
success
,warning
,error
, orpending
. -
Current stage that the step is in
Values are
starting
,completed
, orin_progress
. -
Human readable summaries of the step, including messages for each stage of the step
Hide info_log attributes Show info_log attributes object
-
Timestamp marking on info log of step
-
delta_in_millis integer(int64)
Time in milliseconds since previous log message
-
Stage that info log message takes place in
Values are
starting
,completed
, orin_progress
. -
Human readable log message
-
A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.
Hide details attribute Show details attribute object
-
internal_details object
A json object with sensitive details for the log, visible only to admins. May contain nested json objects.
Hide internal_details attribute Show internal_details attribute object
-
failure_type string
The failure type, in case the step failed
-
-
-
source object
Information describing the source that facilitated the plans current state
Additional properties are allowed.
Hide source attributes Show source attributes object
-
The service where the change originated from
-
The type of plan change that was initiated
-
The time the change was initiated
-
user_id string
The user that requested the change
-
admin_id string
The admin user that requested the change
-
remote_addresses array[string]
The host addresses of the user that originated the change
-
-
error object
Information about an error during a plan attempt.
Additional properties are allowed.
Hide error attributes Show error attributes object
-
Timestamp marking on info log of step
-
Human readable error message
-
A map with details regarding the error. Both the keys and values are always strings, representing the name of the detail and its value, respectively.
Hide details attribute Show details attribute object
-
failure_type string
The failure type
-
-
-
pending object
Information about the Elasticsearch cluster plan.
Additional properties are allowed.
Hide pending attributes Show pending attributes object
-
plan_attempt_id string
A UUID for each plan attempt
-
plan_attempt_name string
A human readable name for each plan attempt, only populated when retrieving plan histories
-
Either the plan ended successfully, or is not yet completed (and no errors have occurred)
-
attempt_start_time string(date-time)
When this plan attempt (ie to apply the plan to the cluster) started (ISO format in UTC)
-
attempt_end_time string(date-time)
If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)
-
plan_end_time string(date-time)
If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)
-
plan object
The plan for building this Elasticsearch cluster
Additional properties are allowed.
Hide plan attributes Show plan attributes object
-
Hide cluster_topology attributes Show cluster_topology attributes object
-
id string
Unique identifier of this topology element
-
node_type object
Controls the combinations of Elasticsearch node types. TIP: By default, the Elasticsearch node is master eligible, can hold data, and run ingest pipelines. WARNING: Do not set for tiebreaker topologies.
Additional properties are allowed.
Hide node_type attributes Show node_type attributes object
-
master boolean
Defines whether this node can be elected master (default: false)
-
data boolean
Defines whether this node can hold data (default: false)
-
ingest boolean
Defines whether this node can run an ingest pipeline (default: false)
-
ml boolean
Defines whether this node can run ml jobs, valid only for versions 5.4.0 or greater (default: false)
-
-
node_roles array[string]
The list of node roles for this topology element (ES version >= 7.10). Allowable values are: master, ingest, ml, data_hot, data_content, data_warm, data_cold, data_frozen, remote_cluster_client, transform
Values are
master
,ingest
,ml
,data_hot
,data_content
,data_warm
,data_cold
,data_frozen
,remote_cluster_client
, ortransform
. -
memory_per_node integer(int32)
The memory capacity in MB for each node of this type built in each zone.
-
node_count_per_zone integer(int32)
The number of nodes of this type that are allocated within each zone. (i.e. total capacity per zone =
node_count_per_zone
*memory_per_node
in MB). Cannot be set for tiebreaker topologies. For dedicated master nodes, must be 1 if an entry exists. -
zone_count integer(int32)
The default number of zones in which data nodes will be placed
-
elasticsearch object
The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.
Additional properties are allowed.
Hide elasticsearch attributes Show elasticsearch attributes object
-
version string
The version of the Elasticsearch cluster (must be one of the ECE supported versions). Currently cannot be different across the topology (and is generally specified in the globals). Defaults to the latest version if not specified.
-
docker_image string
A docker URI that allows overriding of the default docker image specified for this version
-
system_settings object
A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use
ElasticsearchSystemSettings
withuser_settings_override*
anduser_settings*
.Additional properties are allowed.
Hide system_settings attributes Show system_settings attributes object
-
scripting object
Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON.
Additional properties are allowed.
Hide scripting attributes Show scripting attributes object
-
painless_enabled boolean
(5.x+ only) If enabled (the default) then the painless scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.painless.[file|stored|inline]')
-
mustache_enabled boolean
(5.x+ only) If enabled (the default) then the mustache scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.mustache.[file|stored|inline]')
-
expressions_enabled boolean
(5.x+ only) If enabled (the default) then the expressions scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.expression.[file|stored|inline]')
-
stored object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide stored attributes Show stored attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
file object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide file attributes Show file attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
inline object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide inline attributes Show inline attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
-
reindex_whitelist array[string]
Limits remote Elasticsearch clusters that can be used as the source for '_reindex' API commands
-
auto_create_index boolean
If true (the default), then any write operation on an index that does not currently exist will create it. NOTES: (Corresponds to the parameter 'action.auto_create_index')
-
enable_close_index boolean
Defaults to false on versions <= 7.2.0, true otherwise. If false, then the API commands to close indices are disabled. This is important because Elasticsearch does not snapshot or migrate close indices on versions under 7.2.0, therefore standard Elastic Cloud configuration operations will cause irretrievable loss of indices' data. NOTES: (Corresponds to the parameter 'cluster.indices.close.enable')
-
destructive_requires_name boolean
If true (default is false) then the index deletion API will not support wildcards or '_all'. NOTES: (Corresponds to the parameter 'action.destructive_requires_name')
-
watcher_trigger_engine string
The trigger engine for Watcher, defaults to 'scheduler' - see the xpack documentation for more information. NOTES: (Corresponds to the parameter '(xpack.)watcher.trigger.schedule.engine', depending on version. Ignored from 6.x onwards.)
-
default_shards_per_index integer(int32)
(2.x only - to get the same result in 5.x template mappings must be used) Sets the default number of shards per index, defaulting to 1 if not specified. (Corresponds to the parameter 'index.number_of_shards' in 2.x, not supported in 5.x)
-
monitoring_collection_interval integer(int32)
The default interval at which monitoring information from the cluster if collected, if monitoring is enabled. NOTES: (Corresponds to the parameter 'marvel.agent.interval' in 2.x and 'xpack.monitoring.collection.interval' in 5.x)
-
monitoring_history_duration string
The duration for which monitoring history is stored (format '(NUMBER)d' eg '3d' for 3 days). NOTES: ('Corresponds to the parameter xpack.monitoring.history.duration' in 5.x, defaults to '7d')
-
-
user_settings_json object
An arbitrary JSON object allowing cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
Additional properties are allowed.
-
user_settings_yaml string
An arbitrary YAML object allowing cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
-
user_settings_override_json object
An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
Additional properties are allowed.
-
user_settings_override_yaml string
An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
-
enabled_built_in_plugins array[string]
A list of plugin names from the Elastic-supported subset that are bundled with the version images. NOTES: (Users should consult the Elastic stack objects to see what plugins are available, this is currently only available from the UI)
-
user_plugins array[object]
A list of admin-uploaded plugin objects that are available for this user.
Hide user_plugins attributes Show user_plugins attributes object
-
The name of the plugin
-
The URL of the plugin (must be accessible from the ECE infrastructure)
-
The supported Elasticsearch version (must match the version in the plan)
-
-
user_bundles array[object]
A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user.
Hide user_bundles attributes Show user_bundles attributes object
-
The name of the bundle
-
The URL of the bundle, which must be accessible from the ECE infrastructure. This URL could be cached by platform, make sure to change it when updating the bundle
-
The supported Elasticsearch version (must match the version in the plan)
-
-
curation object
Defines the index curation routing for the cluster
Additional properties are allowed.
Hide curation attributes Show curation attributes object
-
The source instance configuration
-
The destination instance configuration
-
-
node_attributes object
Defines the Elasticsearch node attributes for the instances in the topology
Hide node_attributes attribute Show node_attributes attribute object
-
-
instance_configuration_id string
Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
-
instance_configuration_version integer(int32)
The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.
-
size object
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
Additional properties are allowed.
-
autoscaling_min object
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
Additional properties are allowed.
-
autoscaling_max object
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
Additional properties are allowed.
-
An arbitrary JSON object overriding the default autoscaling policy. Don't set unless you really know what you are doing.
Additional properties are allowed.
-
topology_element_control object
Controls for the topology element. Only used as part of the deployment template. Ignored if included as part of a deployment.
Additional properties are allowed.
Hide topology_element_control attribute Show topology_element_control attribute object
-
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
Additional properties are allowed.
-
-
autoscaling_tier_override boolean
Set to true to enable autoscaling for this topology element, even if the cluster-level 'autoscaling_enabled' field is false. Note that 'autoscaling_tier_override' cannot be set to false if cluster-level 'autoscaling_enabled' is true. Currently only supported for the 'ml' tier
-
-
The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.
Additional properties are allowed.
Hide elasticsearch attributes Show elasticsearch attributes object
-
version string
The version of the Elasticsearch cluster (must be one of the ECE supported versions). Currently cannot be different across the topology (and is generally specified in the globals). Defaults to the latest version if not specified.
-
docker_image string
A docker URI that allows overriding of the default docker image specified for this version
-
system_settings object
A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use
ElasticsearchSystemSettings
withuser_settings_override*
anduser_settings*
.Additional properties are allowed.
Hide system_settings attributes Show system_settings attributes object
-
scripting object
Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON.
Additional properties are allowed.
Hide scripting attributes Show scripting attributes object
-
painless_enabled boolean
(5.x+ only) If enabled (the default) then the painless scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.painless.[file|stored|inline]')
-
mustache_enabled boolean
(5.x+ only) If enabled (the default) then the mustache scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.mustache.[file|stored|inline]')
-
expressions_enabled boolean
(5.x+ only) If enabled (the default) then the expressions scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.expression.[file|stored|inline]')
-
stored object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide stored attributes Show stored attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
file object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide file attributes Show file attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
inline object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide inline attributes Show inline attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
-
reindex_whitelist array[string]
Limits remote Elasticsearch clusters that can be used as the source for '_reindex' API commands
-
auto_create_index boolean
If true (the default), then any write operation on an index that does not currently exist will create it. NOTES: (Corresponds to the parameter 'action.auto_create_index')
-
enable_close_index boolean
Defaults to false on versions <= 7.2.0, true otherwise. If false, then the API commands to close indices are disabled. This is important because Elasticsearch does not snapshot or migrate close indices on versions under 7.2.0, therefore standard Elastic Cloud configuration operations will cause irretrievable loss of indices' data. NOTES: (Corresponds to the parameter 'cluster.indices.close.enable')
-
destructive_requires_name boolean
If true (default is false) then the index deletion API will not support wildcards or '_all'. NOTES: (Corresponds to the parameter 'action.destructive_requires_name')
-
watcher_trigger_engine string
The trigger engine for Watcher, defaults to 'scheduler' - see the xpack documentation for more information. NOTES: (Corresponds to the parameter '(xpack.)watcher.trigger.schedule.engine', depending on version. Ignored from 6.x onwards.)
-
default_shards_per_index integer(int32)
(2.x only - to get the same result in 5.x template mappings must be used) Sets the default number of shards per index, defaulting to 1 if not specified. (Corresponds to the parameter 'index.number_of_shards' in 2.x, not supported in 5.x)
-
monitoring_collection_interval integer(int32)
The default interval at which monitoring information from the cluster if collected, if monitoring is enabled. NOTES: (Corresponds to the parameter 'marvel.agent.interval' in 2.x and 'xpack.monitoring.collection.interval' in 5.x)
-
monitoring_history_duration string
The duration for which monitoring history is stored (format '(NUMBER)d' eg '3d' for 3 days). NOTES: ('Corresponds to the parameter xpack.monitoring.history.duration' in 5.x, defaults to '7d')
-
-
user_settings_json object
An arbitrary JSON object allowing cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
Additional properties are allowed.
-
user_settings_yaml string
An arbitrary YAML object allowing cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
-
user_settings_override_json object
An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
Additional properties are allowed.
-
user_settings_override_yaml string
An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
-
enabled_built_in_plugins array[string]
A list of plugin names from the Elastic-supported subset that are bundled with the version images. NOTES: (Users should consult the Elastic stack objects to see what plugins are available, this is currently only available from the UI)
-
user_plugins array[object]
A list of admin-uploaded plugin objects that are available for this user.
Hide user_plugins attributes Show user_plugins attributes object
-
The name of the plugin
-
The URL of the plugin (must be accessible from the ECE infrastructure)
-
The supported Elasticsearch version (must match the version in the plan)
-
-
user_bundles array[object]
A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user.
Hide user_bundles attributes Show user_bundles attributes object
-
The name of the bundle
-
The URL of the bundle, which must be accessible from the ECE infrastructure. This URL could be cached by platform, make sure to change it when updating the bundle
-
The supported Elasticsearch version (must match the version in the plan)
-
-
curation object
Defines the index curation routing for the cluster
Additional properties are allowed.
Hide curation attributes Show curation attributes object
-
The source instance configuration
-
The destination instance configuration
-
-
node_attributes object
Defines the Elasticsearch node attributes for the instances in the topology
Hide node_attributes attribute Show node_attributes attribute object
-
-
deployment_template object
Documents which deployment template was used in the creation of this plan
Additional properties are allowed.
-
transient object
Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Elasticsearch settings.
Additional properties are allowed.
Hide transient attributes Show transient attributes object
-
strategy object
The options for performing a plan change. Specify only one property each time. The default is
grow_and_shrink
.Additional properties are allowed.
Hide strategy attributes Show strategy attributes object
-
rolling object
Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.
Additional properties are allowed.
Hide rolling attributes Show rolling attributes object
-
group_by string
Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade
-
allow_inline_resize boolean
Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing
-
skip_synced_flush boolean
Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy
-
shard_init_wait_time integer(int64)
The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)
-
-
grow_and_shrink object
A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances.
GrowShrinkStrategyConfig
is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.Additional properties are allowed.
-
rolling_grow_and_shrink object
A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.
Additional properties are allowed.
-
autodetect object
A strategy that lets constructor choose the most optimal way to execute the plan.
Additional properties are allowed.
-
-
plan_configuration object
The configuration settings for the timeout and fallback parameters.
Additional properties are allowed.
Hide plan_configuration attributes Show plan_configuration attributes object
-
timeout integer(int64)
The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB). NOTES: A 3 zone cluster with 2 nodes of 2048 each would have a timeout of 4*2048=8192 seconds. Timeout does not include time required to run rollback actions.
-
calm_wait_time integer(int64)
This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
-
move_instances array[object]
Hide move_instances attributes Show move_instances attributes object
-
The instance id that is going to be moved
-
to array[string]
An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
-
instance_down boolean
Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)
-
-
move_allocators array[object]
Hide move_allocators attributes Show move_allocators attributes object
-
The allocator id off which all instances in the cluster should be moved
-
to array[string]
An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
-
allocator_down boolean
Tells the infrastructure that all instances on the allocator should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will auto-decide (currently: will treat the allocator as up)
-
-
move_only boolean
If true (default: false) only move_instances and move_allocators instructions will be executed, all other changes will be ignored
-
reallocate_instances boolean
If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created
-
preferred_allocators array[string]
List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)
-
preferred_allocator_tags object
Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators
Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
-
skip_snapshot boolean
If true (default: false), does not take (or require) a successful snapshot to be taken before performing any potentially destructive changes to this cluster
-
max_snapshot_attempts integer(int32)
If taking a snapshot (ie unless 'skip_snapshots': true) then will retry on failure at most this number of times (default: 5)
-
max_snapshot_age integer(int64)
When you take a snapshot and 'skip_snapshots' is false, specifies the maximum age in seconds of the most recent snapshot before a new snapshot is created. Default is 300
-
extended_maintenance boolean
If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster
-
cluster_reboot string
Set to 'forced' to force a reboot as part of the upgrade plan. NOTES: (ie taking an existing plan and leaving it alone except for setting 'transient.plan_configuration.cluster_reboot': 'forced' will reboot the cluster)
Value is
forced
. -
override_failsafe boolean
If false (the default) then the plan will fail out if it believes the requested sequence of operations can result in data loss - this flag will override some of these restraints
-
skip_data_migration boolean
If true (default: false) then the plan will not wait for data to be migrated from old instances to new instances before continuing the plan (potentially deleting the old instances and losing data)
-
skip_upgrade_checker boolean
If false, the cluster is checked for issues that should be resolved before migration (eg contains old Lucene segments), if true this is bypassed
-
skip_post_upgrade_steps boolean
If false (the default), the cluster will run (currently) 2.x->5.x operations for any plan change ending with a 5.x cluster (eg apply a cluster license, ensure Monitoring is configured)
-
skip_snapshot_post_major_upgrade boolean
If false (the default), the cluster will perform a snapshot after a major version upgrade takes place
-
-
restore_snapshot object
Restores a snapshot from a local or remote repository.
Additional properties are allowed.
Hide restore_snapshot attributes Show restore_snapshot attributes object
-
repository_name string
If specified, contains the name of the snapshot repository - else will default to the Elastic Cloud system repo ('found-snapshots')
-
The name of the snapshot to restore. Use '__latest_success__' to get the most recent snapshot from the specified repository
-
repository_config object
Raw remote snapshot restore settings. Do not send this if you are sending source_cluster_id
Additional properties are allowed.
Hide repository_config attribute Show repository_config attribute object
-
raw_settings object
The remote snapshot settings raw JSON - see the Elasticsearch '_snapshot' documentation for more details on supported formats
Additional properties are allowed.
-
-
restore_payload object
The configuration for the restore command, such as which indices you want to restore.
Additional properties are allowed.
Hide restore_payload attributes Show restore_payload attributes object
-
indices array[string]
The list of indices to restore (supports +ve and -ve selection and wildcarding - see the default Elasticsearch index format documentation)
-
raw_settings object
This JSON object (merged with the 'indices' field (if present) is passed untouched into the restore command - see the Elasticsearch '_snapshot' documentation for more details on supported formats
Additional properties are allowed.
-
-
strategy string
The restore strategy to use. Defaults to a full restore. Partial restore will attempt to restore unavailable indices only
Values are
partial
,full
, orrecovery
. -
source_cluster_id string
If specified, contains the name of the source cluster id. Do not send this if you are sending repository_config
-
-
remote_clusters object
The list of resources that will be configured as remote clusters
Additional properties are allowed.
Hide remote_clusters attribute Show remote_clusters attribute object
-
The remote resources
Hide resources attributes Show resources attributes object
-
The id of the deployment
-
The locally-unique user-specified id of an Elasticsearch Resource
-
The alias for this remote cluster. Aliases must only contain letters, digits, dashes and underscores
-
skip_unavailable boolean
If true, skip this cluster during search if it is disconnected. Default: false
-
info object
Information about a Remote Cluster.
Additional properties are allowed.
Hide info attributes Show info attributes object
-
Whether or not the remote cluster is healthy
-
Whether or not there is at least one connection to the remote cluster.
-
Whether or not the remote cluster version is compatible with this cluster version.
-
Whether or not the remote cluster is trusted by this cluster.
-
Whether or not the remote cluster trusts this cluster back.
-
-
-
-
cluster_settings_json object
If specified, contains transient settings to be applied to an Elasticsearch cluster during changes,default values shown below applied. These can be overridden by specifying them in the map (or null to unset). Additional settings can also be set. Settings will be cleared after the plan has finished. If not specified, no settings will be applied. NOTE: These settings are only explicitly cleared for 5.x+ clusters, they must be hand-reset to their defaults in 2.x- (or a cluster reboot will clear them).
- indices.store.throttle.max_bytes_per_sec: 120Mb
- indices.recovery.max_bytes_per_sec: 120Mb
- cluster.routing.allocation.cluster_concurrent_rebalance: 5
- cluster.routing.allocation.node_initial_primaries_recoveries: 5
- cluster.routing.allocation.node_concurrent_incoming_recoveries: 5 For version 8.1 and later no defaults are provided through this mechanism, but instead hardware dependent settings are provided to each instance.
Additional properties are allowed.
-
-
autoscaling_enabled boolean
Enable autoscaling for this Elasticsearch cluster.
-
-
Hide plan_attempt_log attributes Show plan_attempt_log attributes object
-
ID of current step
-
When the step started (ISO format in UTC)
-
completed string(date-time)
When the step completed (ISO format in UTC)
-
duration_in_millis integer(int64)
The duration of the step in MS
-
The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)
Values are
success
,warning
,error
, orpending
. -
Current stage that the step is in
Values are
starting
,completed
, orin_progress
. -
Human readable summaries of the step, including messages for each stage of the step
Hide info_log attributes Show info_log attributes object
-
Timestamp marking on info log of step
-
delta_in_millis integer(int64)
Time in milliseconds since previous log message
-
Stage that info log message takes place in
Values are
starting
,completed
, orin_progress
. -
Human readable log message
-
A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.
Hide details attribute Show details attribute object
-
internal_details object
A json object with sensitive details for the log, visible only to admins. May contain nested json objects.
Hide internal_details attribute Show internal_details attribute object
-
failure_type string
The failure type, in case the step failed
-
-
-
source object
Information describing the source that facilitated the plans current state
Additional properties are allowed.
Hide source attributes Show source attributes object
-
The service where the change originated from
-
The type of plan change that was initiated
-
The time the change was initiated
-
user_id string
The user that requested the change
-
admin_id string
The admin user that requested the change
-
remote_addresses array[string]
The host addresses of the user that originated the change
-
-
error object
Information about an error during a plan attempt.
Additional properties are allowed.
Hide error attributes Show error attributes object
-
Timestamp marking on info log of step
-
Human readable error message
-
A map with details regarding the error. Both the keys and values are always strings, representing the name of the detail and its value, respectively.
Hide details attribute Show details attribute object
-
failure_type string
The failure type
-
-
-
Hide history attributes Show history attributes object
-
plan_attempt_id string
A UUID for each plan attempt
-
plan_attempt_name string
A human readable name for each plan attempt, only populated when retrieving plan histories
-
Either the plan ended successfully, or is not yet completed (and no errors have occurred)
-
attempt_start_time string(date-time)
When this plan attempt (ie to apply the plan to the cluster) started (ISO format in UTC)
-
attempt_end_time string(date-time)
If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)
-
plan_end_time string(date-time)
If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)
-
plan object
The plan for building this Elasticsearch cluster
Additional properties are allowed.
Hide plan attributes Show plan attributes object
-
Hide cluster_topology attributes Show cluster_topology attributes object
-
id string
Unique identifier of this topology element
-
node_type object
Controls the combinations of Elasticsearch node types. TIP: By default, the Elasticsearch node is master eligible, can hold data, and run ingest pipelines. WARNING: Do not set for tiebreaker topologies.
Additional properties are allowed.
Hide node_type attributes Show node_type attributes object
-
master boolean
Defines whether this node can be elected master (default: false)
-
data boolean
Defines whether this node can hold data (default: false)
-
ingest boolean
Defines whether this node can run an ingest pipeline (default: false)
-
ml boolean
Defines whether this node can run ml jobs, valid only for versions 5.4.0 or greater (default: false)
-
-
node_roles array[string]
The list of node roles for this topology element (ES version >= 7.10). Allowable values are: master, ingest, ml, data_hot, data_content, data_warm, data_cold, data_frozen, remote_cluster_client, transform
Values are
master
,ingest
,ml
,data_hot
,data_content
,data_warm
,data_cold
,data_frozen
,remote_cluster_client
, ortransform
. -
memory_per_node integer(int32)
The memory capacity in MB for each node of this type built in each zone.
-
node_count_per_zone integer(int32)
The number of nodes of this type that are allocated within each zone. (i.e. total capacity per zone =
node_count_per_zone
*memory_per_node
in MB). Cannot be set for tiebreaker topologies. For dedicated master nodes, must be 1 if an entry exists. -
zone_count integer(int32)
The default number of zones in which data nodes will be placed
-
elasticsearch object
The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.
Additional properties are allowed.
Hide elasticsearch attributes Show elasticsearch attributes object
-
version string
The version of the Elasticsearch cluster (must be one of the ECE supported versions). Currently cannot be different across the topology (and is generally specified in the globals). Defaults to the latest version if not specified.
-
docker_image string
A docker URI that allows overriding of the default docker image specified for this version
-
system_settings object
A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use
ElasticsearchSystemSettings
withuser_settings_override*
anduser_settings*
.Additional properties are allowed.
Hide system_settings attributes Show system_settings attributes object
-
scripting object
Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON.
Additional properties are allowed.
Hide scripting attributes Show scripting attributes object
-
painless_enabled boolean
(5.x+ only) If enabled (the default) then the painless scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.painless.[file|stored|inline]')
-
mustache_enabled boolean
(5.x+ only) If enabled (the default) then the mustache scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.mustache.[file|stored|inline]')
-
expressions_enabled boolean
(5.x+ only) If enabled (the default) then the expressions scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.expression.[file|stored|inline]')
-
stored object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide stored attributes Show stored attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
file object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide file attributes Show file attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
inline object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide inline attributes Show inline attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
-
reindex_whitelist array[string]
Limits remote Elasticsearch clusters that can be used as the source for '_reindex' API commands
-
auto_create_index boolean
If true (the default), then any write operation on an index that does not currently exist will create it. NOTES: (Corresponds to the parameter 'action.auto_create_index')
-
enable_close_index boolean
Defaults to false on versions <= 7.2.0, true otherwise. If false, then the API commands to close indices are disabled. This is important because Elasticsearch does not snapshot or migrate close indices on versions under 7.2.0, therefore standard Elastic Cloud configuration operations will cause irretrievable loss of indices' data. NOTES: (Corresponds to the parameter 'cluster.indices.close.enable')
-
destructive_requires_name boolean
If true (default is false) then the index deletion API will not support wildcards or '_all'. NOTES: (Corresponds to the parameter 'action.destructive_requires_name')
-
watcher_trigger_engine string
The trigger engine for Watcher, defaults to 'scheduler' - see the xpack documentation for more information. NOTES: (Corresponds to the parameter '(xpack.)watcher.trigger.schedule.engine', depending on version. Ignored from 6.x onwards.)
-
default_shards_per_index integer(int32)
(2.x only - to get the same result in 5.x template mappings must be used) Sets the default number of shards per index, defaulting to 1 if not specified. (Corresponds to the parameter 'index.number_of_shards' in 2.x, not supported in 5.x)
-
monitoring_collection_interval integer(int32)
The default interval at which monitoring information from the cluster if collected, if monitoring is enabled. NOTES: (Corresponds to the parameter 'marvel.agent.interval' in 2.x and 'xpack.monitoring.collection.interval' in 5.x)
-
monitoring_history_duration string
The duration for which monitoring history is stored (format '(NUMBER)d' eg '3d' for 3 days). NOTES: ('Corresponds to the parameter xpack.monitoring.history.duration' in 5.x, defaults to '7d')
-
-
user_settings_json object
An arbitrary JSON object allowing cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
Additional properties are allowed.
-
user_settings_yaml string
An arbitrary YAML object allowing cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
-
user_settings_override_json object
An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
Additional properties are allowed.
-
user_settings_override_yaml string
An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
-
enabled_built_in_plugins array[string]
A list of plugin names from the Elastic-supported subset that are bundled with the version images. NOTES: (Users should consult the Elastic stack objects to see what plugins are available, this is currently only available from the UI)
-
user_plugins array[object]
A list of admin-uploaded plugin objects that are available for this user.
Hide user_plugins attributes Show user_plugins attributes object
-
The name of the plugin
-
The URL of the plugin (must be accessible from the ECE infrastructure)
-
The supported Elasticsearch version (must match the version in the plan)
-
-
user_bundles array[object]
A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user.
Hide user_bundles attributes Show user_bundles attributes object
-
The name of the bundle
-
The URL of the bundle, which must be accessible from the ECE infrastructure. This URL could be cached by platform, make sure to change it when updating the bundle
-
The supported Elasticsearch version (must match the version in the plan)
-
-
curation object
Defines the index curation routing for the cluster
Additional properties are allowed.
Hide curation attributes Show curation attributes object
-
The source instance configuration
-
The destination instance configuration
-
-
node_attributes object
Defines the Elasticsearch node attributes for the instances in the topology
Hide node_attributes attribute Show node_attributes attribute object
-
-
instance_configuration_id string
Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
-
instance_configuration_version integer(int32)
The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.
-
size object
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
Additional properties are allowed.
-
autoscaling_min object
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
Additional properties are allowed.
-
autoscaling_max object
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
Additional properties are allowed.
-
An arbitrary JSON object overriding the default autoscaling policy. Don't set unless you really know what you are doing.
Additional properties are allowed.
-
topology_element_control object
Controls for the topology element. Only used as part of the deployment template. Ignored if included as part of a deployment.
Additional properties are allowed.
Hide topology_element_control attribute Show topology_element_control attribute object
-
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
Additional properties are allowed.
-
-
autoscaling_tier_override boolean
Set to true to enable autoscaling for this topology element, even if the cluster-level 'autoscaling_enabled' field is false. Note that 'autoscaling_tier_override' cannot be set to false if cluster-level 'autoscaling_enabled' is true. Currently only supported for the 'ml' tier
-
-
The Elasticsearch cluster settings. When specified at the top level, provides a field-by-field default. When specified at the topology level, provides the override settings.
Additional properties are allowed.
Hide elasticsearch attributes Show elasticsearch attributes object
-
version string
The version of the Elasticsearch cluster (must be one of the ECE supported versions). Currently cannot be different across the topology (and is generally specified in the globals). Defaults to the latest version if not specified.
-
docker_image string
A docker URI that allows overriding of the default docker image specified for this version
-
system_settings object
A subset of Elasticsearch settings. TIP: To define the complete set of Elasticsearch settings, use
ElasticsearchSystemSettings
withuser_settings_override*
anduser_settings*
.Additional properties are allowed.
Hide system_settings attributes Show system_settings attributes object
-
scripting object
Controls the languages supported by the Elasticsearch cluster, such as Painless, Mustache, and Expressions. Controls how the languages are used, such as file, index, and inline. TIP: For complex configurations, leave these blank and configure these settings in the user YAML or JSON.
Additional properties are allowed.
Hide scripting attributes Show scripting attributes object
-
painless_enabled boolean
(5.x+ only) If enabled (the default) then the painless scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.painless.[file|stored|inline]')
-
mustache_enabled boolean
(5.x+ only) If enabled (the default) then the mustache scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.mustache.[file|stored|inline]')
-
expressions_enabled boolean
(5.x+ only) If enabled (the default) then the expressions scripting engine is allowed as a sandboxed language. Sandboxed languages are the only ones allowed if 'sandbox_mode' is set to true. NOTES: (Corresponds to the parameters 'script.engine.expression.[file|stored|inline]')
-
stored object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide stored attributes Show stored attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
file object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide file attributes Show file attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
inline object
Enables scripting for the specified type and controls other parameters. Store scripts in indexes (
stored
), upload in file bundles (file
), or use in API requests (inline
).Additional properties are allowed.
Hide inline attributes Show inline attributes object
-
enabled boolean
If enabled (default: true) then scripts are enabled, either for sandboxing languages (by default), or for all installed languages if 'sandbox_mode' is disabled (or for 6.x). NOTES: (Corresponds to the parameter 'script.file|stored/indexed|inline')
-
sandbox_mode boolean
If enabled (default: true) and this script type is enabled, then only the sandbox languages are allowed. By default the sandbox languages are painless, expressions and mustache, but this can be restricted via the 'painless_enabled', 'mustache_enabled' 'expression_enabled' settings.NOTES: Not supported in 6.x. (Corresponds to the parameters 'script.engine.[painless|mustache|expressions].[file|stored|inline]')
-
-
-
reindex_whitelist array[string]
Limits remote Elasticsearch clusters that can be used as the source for '_reindex' API commands
-
auto_create_index boolean
If true (the default), then any write operation on an index that does not currently exist will create it. NOTES: (Corresponds to the parameter 'action.auto_create_index')
-
enable_close_index boolean
Defaults to false on versions <= 7.2.0, true otherwise. If false, then the API commands to close indices are disabled. This is important because Elasticsearch does not snapshot or migrate close indices on versions under 7.2.0, therefore standard Elastic Cloud configuration operations will cause irretrievable loss of indices' data. NOTES: (Corresponds to the parameter 'cluster.indices.close.enable')
-
destructive_requires_name boolean
If true (default is false) then the index deletion API will not support wildcards or '_all'. NOTES: (Corresponds to the parameter 'action.destructive_requires_name')
-
watcher_trigger_engine string
The trigger engine for Watcher, defaults to 'scheduler' - see the xpack documentation for more information. NOTES: (Corresponds to the parameter '(xpack.)watcher.trigger.schedule.engine', depending on version. Ignored from 6.x onwards.)
-
default_shards_per_index integer(int32)
(2.x only - to get the same result in 5.x template mappings must be used) Sets the default number of shards per index, defaulting to 1 if not specified. (Corresponds to the parameter 'index.number_of_shards' in 2.x, not supported in 5.x)
-
monitoring_collection_interval integer(int32)
The default interval at which monitoring information from the cluster if collected, if monitoring is enabled. NOTES: (Corresponds to the parameter 'marvel.agent.interval' in 2.x and 'xpack.monitoring.collection.interval' in 5.x)
-
monitoring_history_duration string
The duration for which monitoring history is stored (format '(NUMBER)d' eg '3d' for 3 days). NOTES: ('Corresponds to the parameter xpack.monitoring.history.duration' in 5.x, defaults to '7d')
-
-
user_settings_json object
An arbitrary JSON object allowing cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
Additional properties are allowed.
-
user_settings_yaml string
An arbitrary YAML object allowing cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters arey are on the allowlist and not on the denylist. NOTES: (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Elasticsearch settings)
-
user_settings_override_json object
An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
Additional properties are allowed.
-
user_settings_override_yaml string
An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. NOTES: (This field together with 'system_settings' and 'user_settings*' defines the total set of Elasticsearch settings)
-
enabled_built_in_plugins array[string]
A list of plugin names from the Elastic-supported subset that are bundled with the version images. NOTES: (Users should consult the Elastic stack objects to see what plugins are available, this is currently only available from the UI)
-
user_plugins array[object]
A list of admin-uploaded plugin objects that are available for this user.
Hide user_plugins attributes Show user_plugins attributes object
-
The name of the plugin
-
The URL of the plugin (must be accessible from the ECE infrastructure)
-
The supported Elasticsearch version (must match the version in the plan)
-
-
user_bundles array[object]
A list of admin-uploaded bundle objects (eg scripts, synonym files) that are available for this user.
Hide user_bundles attributes Show user_bundles attributes object
-
The name of the bundle
-
The URL of the bundle, which must be accessible from the ECE infrastructure. This URL could be cached by platform, make sure to change it when updating the bundle
-
The supported Elasticsearch version (must match the version in the plan)
-
-
curation object
Defines the index curation routing for the cluster
Additional properties are allowed.
Hide curation attributes Show curation attributes object
-
The source instance configuration
-
The destination instance configuration
-
-
node_attributes object
Defines the Elasticsearch node attributes for the instances in the topology
Hide node_attributes attribute Show node_attributes attribute object
-
-
deployment_template object
Documents which deployment template was used in the creation of this plan
Additional properties are allowed.
-
transient object
Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and Elasticsearch settings.
Additional properties are allowed.
Hide transient attributes Show transient attributes object
-
strategy object
The options for performing a plan change. Specify only one property each time. The default is
grow_and_shrink
.Additional properties are allowed.
Hide strategy attributes Show strategy attributes object
-
rolling object
Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.
Additional properties are allowed.
Hide rolling attributes Show rolling attributes object
-
group_by string
Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade
-
allow_inline_resize boolean
Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing
-
skip_synced_flush boolean
Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy
-
shard_init_wait_time integer(int64)
The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)
-
-
grow_and_shrink object
A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances.
GrowShrinkStrategyConfig
is safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters.Additional properties are allowed.
-
rolling_grow_and_shrink object
A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.
Additional properties are allowed.
-
autodetect object
A strategy that lets constructor choose the most optimal way to execute the plan.
Additional properties are allowed.
-
-
plan_configuration object
The configuration settings for the timeout and fallback parameters.
Additional properties are allowed.
Hide plan_configuration attributes Show plan_configuration attributes object
-
timeout integer(int64)
The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB). NOTES: A 3 zone cluster with 2 nodes of 2048 each would have a timeout of 4*2048=8192 seconds. Timeout does not include time required to run rollback actions.
-
calm_wait_time integer(int64)
This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
-
move_instances array[object]
Hide move_instances attributes Show move_instances attributes object
-
The instance id that is going to be moved
-
to array[string]
An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
-
instance_down boolean
Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)
-
-
move_allocators array[object]
Hide move_allocators attributes Show move_allocators attributes object
-
The allocator id off which all instances in the cluster should be moved
-
to array[string]
An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
-
allocator_down boolean
Tells the infrastructure that all instances on the allocator should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will auto-decide (currently: will treat the allocator as up)
-
-
move_only boolean
If true (default: false) only move_instances and move_allocators instructions will be executed, all other changes will be ignored
-
reallocate_instances boolean
If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created
-
preferred_allocators array[string]
List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)
-
preferred_allocator_tags object
Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators
Hide preferred_allocator_tags attribute Show preferred_allocator_tags attribute object
-
skip_snapshot boolean
If true (default: false), does not take (or require) a successful snapshot to be taken before performing any potentially destructive changes to this cluster
-
max_snapshot_attempts integer(int32)
If taking a snapshot (ie unless 'skip_snapshots': true) then will retry on failure at most this number of times (default: 5)
-
max_snapshot_age integer(int64)
When you take a snapshot and 'skip_snapshots' is false, specifies the maximum age in seconds of the most recent snapshot before a new snapshot is created. Default is 300
-
extended_maintenance boolean
If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster
-
cluster_reboot string
Set to 'forced' to force a reboot as part of the upgrade plan. NOTES: (ie taking an existing plan and leaving it alone except for setting 'transient.plan_configuration.cluster_reboot': 'forced' will reboot the cluster)
Value is
forced
. -
override_failsafe boolean
If false (the default) then the plan will fail out if it believes the requested sequence of operations can result in data loss - this flag will override some of these restraints
-
skip_data_migration boolean
If true (default: false) then the plan will not wait for data to be migrated from old instances to new instances before continuing the plan (potentially deleting the old instances and losing data)
-
skip_upgrade_checker boolean
If false, the cluster is checked for issues that should be resolved before migration (eg contains old Lucene segments), if true this is bypassed
-
skip_post_upgrade_steps boolean
If false (the default), the cluster will run (currently) 2.x->5.x operations for any plan change ending with a 5.x cluster (eg apply a cluster license, ensure Monitoring is configured)
-
skip_snapshot_post_major_upgrade boolean
If false (the default), the cluster will perform a snapshot after a major version upgrade takes place
-
-
restore_snapshot object
Restores a snapshot from a local or remote repository.
Additional properties are allowed.
Hide restore_snapshot attributes Show restore_snapshot attributes object
-
repository_name string
If specified, contains the name of the snapshot repository - else will default to the Elastic Cloud system repo ('found-snapshots')
-
The name of the snapshot to restore. Use '__latest_success__' to get the most recent snapshot from the specified repository
-
repository_config object
Raw remote snapshot restore settings. Do not send this if you are sending source_cluster_id
Additional properties are allowed.
Hide repository_config attribute Show repository_config attribute object
-
raw_settings object
The remote snapshot settings raw JSON - see the Elasticsearch '_snapshot' documentation for more details on supported formats
Additional properties are allowed.
-
-
restore_payload object
The configuration for the restore command, such as which indices you want to restore.
Additional properties are allowed.
Hide restore_payload attributes Show restore_payload attributes object
-
indices array[string]
The list of indices to restore (supports +ve and -ve selection and wildcarding - see the default Elasticsearch index format documentation)
-
raw_settings object
This JSON object (merged with the 'indices' field (if present) is passed untouched into the restore command - see the Elasticsearch '_snapshot' documentation for more details on supported formats
Additional properties are allowed.
-
-
strategy string
The restore strategy to use. Defaults to a full restore. Partial restore will attempt to restore unavailable indices only
Values are
partial
,full
, orrecovery
. -
source_cluster_id string
If specified, contains the name of the source cluster id. Do not send this if you are sending repository_config
-
-
remote_clusters object
The list of resources that will be configured as remote clusters
Additional properties are allowed.
Hide remote_clusters attribute Show remote_clusters attribute object
-
The remote resources
Hide resources attributes Show resources attributes object
-
The id of the deployment
-
The locally-unique user-specified id of an Elasticsearch Resource
-
The alias for this remote cluster. Aliases must only contain letters, digits, dashes and underscores
-
skip_unavailable boolean
If true, skip this cluster during search if it is disconnected. Default: false
-
info object
Information about a Remote Cluster.
Additional properties are allowed.
Hide info attributes Show info attributes object
-
Whether or not the remote cluster is healthy
-
Whether or not there is at least one connection to the remote cluster.
-
Whether or not the remote cluster version is compatible with this cluster version.
-
Whether or not the remote cluster is trusted by this cluster.
-
Whether or not the remote cluster trusts this cluster back.
-
-
-
-
cluster_settings_json object
If specified, contains transient settings to be applied to an Elasticsearch cluster during changes,default values shown below applied. These can be overridden by specifying them in the map (or null to unset). Additional settings can also be set. Settings will be cleared after the plan has finished. If not specified, no settings will be applied. NOTE: These settings are only explicitly cleared for 5.x+ clusters, they must be hand-reset to their defaults in 2.x- (or a cluster reboot will clear them).
- indices.store.throttle.max_bytes_per_sec: 120Mb
- indices.recovery.max_bytes_per_sec: 120Mb
- cluster.routing.allocation.cluster_concurrent_rebalance: 5
- cluster.routing.allocation.node_initial_primaries_recoveries: 5
- cluster.routing.allocation.node_concurrent_incoming_recoveries: 5 For version 8.1 and later no defaults are provided through this mechanism, but instead hardware dependent settings are provided to each instance.
Additional properties are allowed.
-
-
autoscaling_enabled boolean
Enable autoscaling for this Elasticsearch cluster.
-
-
Hide plan_attempt_log attributes Show plan_attempt_log attributes object
-
ID of current step
-
When the step started (ISO format in UTC)
-
completed string(date-time)
When the step completed (ISO format in UTC)
-
duration_in_millis integer(int64)
The duration of the step in MS
-
The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)
Values are
success
,warning
,error
, orpending
. -
Current stage that the step is in
Values are
starting
,completed
, orin_progress
. -
Human readable summaries of the step, including messages for each stage of the step
Hide info_log attributes Show info_log attributes object
-
Timestamp marking on info log of step
-
delta_in_millis integer(int64)
Time in milliseconds since previous log message
-
Stage that info log message takes place in
Values are
starting
,completed
, orin_progress
. -
Human readable log message
-
A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.
Hide details attribute Show details attribute object
-
internal_details object
A json object with sensitive details for the log, visible only to admins. May contain nested json objects.
Hide internal_details attribute Show internal_details attribute object
-
failure_type string
The failure type, in case the step failed
-
-
-
source object
Information describing the source that facilitated the plans current state
Additional properties are allowed.
Hide source attributes Show source attributes object
-
The service where the change originated from
-
The type of plan change that was initiated
-
The time the change was initiated
-
user_id string
The user that requested the change
-
admin_id string
The admin user that requested the change
-
remote_addresses array[string]
The host addresses of the user that originated the change
-
-
error object
Information about an error during a plan attempt.
Additional properties are allowed.
Hide error attributes Show error attributes object
-
Timestamp marking on info log of step
-
Human readable error message
-
A map with details regarding the error. Both the keys and values are always strings, representing the name of the detail and its value, respectively.
Hide details attribute Show details attribute object
-
failure_type string
The failure type
-
-
-
-
Information about the Elasticsearch cluster.
Additional properties are allowed.
Hide elasticsearch attributes Show elasticsearch attributes object
-
Whether the Elasticsearch cluster is healthy (check the sub-objects for more details if not)
-
WARNING This endpoint is deprecated and scheduled to be removed in the next major version. Use
shards_status
instead.Elasticsearch shard info
Additional properties are allowed.
Hide shard_info attributes Show shard_info attributes object
-
Whether the shard situation is healthy (any unavailable shards is unhealthy)
-
Hide available_shards attributes Show available_shards attributes object
-
The Elastic Cloud name/id of the instance (container)
-
The number of shards of the given type (available/unavailable) on this instance
-
-
Hide unavailable_shards attributes Show unavailable_shards attributes object
-
The Elastic Cloud name/id of the instance (container)
-
The number of shards of the given type (available/unavailable) on this instance
-
-
Hide unavailable_replicas attributes Show unavailable_replicas attributes object
-
The Elastic Cloud name/id of the instance (container)
-
The number of unavailable replicas on this instance
-
-
-
shards_status object
Shards status represented as green, yellow, or red, as returned by the Elasticsearch cluster health API
Additional properties are allowed.
Hide shards_status attribute Show shards_status attribute object
-
Indicates the elasticsearch cluster health status as a color
Values are
green
,red
, oryellow
.
-
-
Information about the master nodes in the Elasticsearch cluster.
Additional properties are allowed.
Hide master_info attributes Show master_info attributes object
-
Whether the master situation in the cluster is healthy (ie is the number of masters != 1), or do any instances have no master
-
Hide masters attributes Show masters attributes object
-
The Elasticsearch node id of a master node
-
master_instance_name string
The corresponding instance name of the container hosting the Elasticsearch master node, if available
-
The names of the instance/container hosting the node belong to the cluster with the given master
-
-
A list of any instances with no master
-
-
WARNING This endpoint is deprecated and scheduled to be removed in the next major version. Use
cluster_blocking_issues
instead.cluster-wide and/or index blocks
Additional properties are allowed.
Hide blocking_issues attributes Show blocking_issues attributes object
-
Whether the cluster has issues (false) or not (true)
-
A list of issues that affect availability of entire cluster
Hide cluster_level attributes Show cluster_level attributes object
-
Description of the issue
-
A list of instances that are affected by the issue
-
-
A list of issues that affect availability of the cluster's indices
Hide index_level attributes Show index_level attributes object
-
Description of the issue
-
A list of instances that are affected by the issue
-
-
-
cluster_blocking_issues object
Issues that prevent the Elasticsearch cluster or index from correctly operating.
Additional properties are allowed.
Hide cluster_blocking_issues attributes Show cluster_blocking_issues attributes object
-
Whether the cluster has issues (false) or not (true)
-
A list of blocks that affect the availability of the cluster
Hide blocks attributes Show blocks attributes object
-
Description of the block
-
Applicable level for the block. Either global ie. cluster-wide or index level
Values are
index
orglobal
.
-
-
-
-
Information about the public and internal state, and the configuration settings of an Elasticsearch cluster.
Additional properties are allowed.
Hide metadata attributes Show metadata attributes object
-
The resource version number of the cluster metadata
-
The most recent time the cluster metadata was changed (ISO format in UTC)
-
endpoint string
The DNS name of the cluster endpoint, if available
-
service_url string
The full URL to access this deployment resource
-
aliased_endpoint string
The DNS name of the cluster endpoint derived from the deployment alias, if available
-
aliased_url string
The full aliased URL to access this deployment resource
-
cloud_id string
The cloud ID, an encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana (only present if both exist)
-
raw object
An unstructured JSON representation of the public and internal state (can be filtered out via URL parameter). The contents and structure of the
raw
field can change at any time.Additional properties are allowed.
-
ports object
The ports that allow communication with the cluster using various protocols.
Additional properties are allowed.
Hide ports attributes Show ports attributes object
-
Port where the cluster listens for HTTP traffic
-
Port where the cluster listens for HTTPS traffic
-
Port where the cluster listens for transport traffic using TLS
-
-
services_urls array[object]
A list of the URLs to access services that the resource provides at this time. Note that if the service is not running or has not started yet, the URL to access it won't be available
-
-
The topology for Elasticsearch clusters, multiple Kibana instances, or multiple APM Servers. The
ClusterTopologyInfo
also includes the instances and containers, and where they are located.Additional properties are allowed.
Hide topology attributes Show topology attributes object
-
Whether the cluster topology is healthy (ie all instances are started and the services they run - ie elasticsearch - are available
-
Hide instances attributes Show instances attributes object
-
The name of the instance in Elastic Cloud
-
instance_configuration object
Information about a configuration that creates a Kibana instance or APM Server.
Additional properties are allowed.
Hide instance_configuration attributes Show instance_configuration attributes object
-
The id of the configuration used to create the instance
-
The name of the configuration used to create the instance
-
config_version integer(int32)
If the IC is configuration controlled, this field is the version either being read back (reads return the latest IC unless specified by the 'config_version' URL param), or the version to update. Cannot be used in creates. For unversioned IC reads it is left empty.
-
The resource type of the instance configuration
Values are
memory
orstorage
.
-
-
service_version string
The version of the service that the instance is running (eg Elasticsearch or Kibana), if available
-
Whether the instance is healthy (ie started and running)
-
Whether the container has started (does not tell you anything about the service -ie Elasticsearch- running inside the container)
-
Whether the service launched inside the container -ie Elasticsearch- is actually running
-
Whether the service is is maintenance mode (meaning that the proxy is not routing external traffic to it)
-
zone string
The zone in which this instance is being allocated
-
allocator_id string
The id of the allocator on which this instance is running (if the container is started or starting)
-
memory object
Information about the specific instances memory capacity and its usage
Additional properties are allowed.
Hide memory attributes Show memory attributes object
-
The memory capacity in MB of the instance
-
instance_capacity_planned integer(int32)
The planned memory capacity in MB of the instance (only shown when an override is present)
-
memory_pressure integer(int32)
The % memory pressure of Elasticsearch JVM heap space if available (60-75% consider increasing capacity, >75% can incur significant performance and stability issues)
-
native_memory_pressure integer(int32)
The % memory pressure of the instance Docker container (if available)
-
-
disk object
Information about the use and storage capacity of a Kibana instance or APM Server.
Additional properties are allowed.
Hide disk attributes Show disk attributes object
-
disk_space_available integer(int64)
If known, the amount of total disk space available to the container in MB
-
The amount of disk space being used by the service in MB
-
The storage multiplier originally defined to calculate disk space.
-
-
service_roles array[string]
List of roles assigned to the service running in the instance. Currently only populated for Elasticsearch, with possible values: master,data,ingest,ml
-
node_roles array[string]
A list of the node roles assigned to the service running in the instance. Currently populated only for Elasticsearch.
Values are
master
,ingest
,ml
,data_hot
,data_content
,data_warm
,data_cold
,data_frozen
,remote_cluster_client
,transform
, orvoting_only
. -
instance_overrides object
Instance overrides
Additional properties are allowed.
Hide instance_overrides attributes Show instance_overrides attributes object
-
capacity integer(int32)
Sets the memory capacity for the instances container. Requires a restart to take effect.
-
storage_multiplier number(double)
Overrides the disk quota multiplier for the instance
-
-
-
-
system_alerts array[object]
List of cluster system alerts
Hide system_alerts attributes Show system_alerts attributes object
-
Timestamp marking the system alert
-
Instance that caused the system alert
-
Type of system alert
Values are
automatic_restart
,heap_dump
, orunknown_event
. -
url string
The URL related to the event. Only applicable for alert_type: heap_dump
-
exit_code integer(int32)
The exit_code related to the event. Only applicable for alert_type: slain
-
-
Hide associated_kibana_clusters attributes Show associated_kibana_clusters attributes object
-
The Kibana cluster Id
-
Whether the associated Kibana cluster is currently available
-
links object
A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation
Hide links attribute Show links attribute object
-
Additional properties are allowed.
Hide * attribute Show * attribute object
-
need_elevated_permissions boolean
Whether the operation requires elevated permissions (when the field is present, elevated permissions are required).
-
-
-
-
Hide associated_apm_clusters attributes Show associated_apm_clusters attributes object
-
The APM cluster Id
-
Whether the associated APM cluster is currently available
-
links object
A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation
Hide links attribute Show links attribute object
-
Additional properties are allowed.
Hide * attribute Show * attribute object
-
need_elevated_permissions boolean
Whether the operation requires elevated permissions (when the field is present, elevated permissions are required).
-
-
-
-
Hide associated_appsearch_clusters attributes Show associated_appsearch_clusters attributes object
-
The App Search Id
-
Whether the associated App Search is currently available
-
links object
A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation
Hide links attribute Show links attribute object
-
Additional properties are allowed.
Hide * attribute Show * attribute object
-
need_elevated_permissions boolean
Whether the operation requires elevated permissions (when the field is present, elevated permissions are required).
-
-
-
-
Hide associated_enterprise_search_clusters attributes Show associated_enterprise_search_clusters attributes object
-
The Enterprise Search Id
-
Whether the associated Enterprise Search is currently available
-
links object
A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation
Hide links attribute Show links attribute object
-
Additional properties are allowed.
Hide * attribute Show * attribute object
-
need_elevated_permissions boolean
Whether the operation requires elevated permissions (when the field is present, elevated permissions are required).
-
-
-
-
security object
For 2.x Elasticsearch clusters, specifies the information about the users and roles. For 5.x Elasticsearch clusters, use the Kibana management UI.
Additional properties are allowed.
Hide security attributes Show security attributes object
-
The resource version number of the security settings
-
The most recent time the security settings were changed (ISO format in UTC)
-
Hide users attributes Show users attributes object
-
The username
-
The hashed password
-
-
An arbitrarily nested JSON object mapping roles to sets of resources and permissions - see the Elasticsearch security documentation for more details on roles
Additional properties are allowed.
-
-
Information about the monitoring status for the Elasticsearch cluster.
Additional properties are allowed.
Hide elasticsearch_monitoring_info attributes Show elasticsearch_monitoring_info attributes object
-
Whether the Monitoring configuration has been successfully applied
-
The time the monitoring configuration was last changed
-
The status message from the last update (successful or not)
-
The list of clusters Ids from which this cluster is currently receiving monitoring data
-
The list of clusters Ids to which this cluster is currently sending monitoring data
-
-
Information about the snapshot status for the Elasticsearch cluster. For example, the health status.
Additional properties are allowed.
Hide snapshots attributes Show snapshots attributes object
-
Health status of snapshots for this cluster
-
Number of snapshots stored for this cluster
-
latest_successful boolean
Latest snapshot status
-
latest_status string
Status of the latest snapshot attempt, if any exist.
-
scheduled_time string(date-time)
Scheduled time of next snapshot attempt
-
latest_end_time string(date-time)
The end time of the most recently attempted snapshot
-
latest_successful_end_time string(date-time)
The end time of the most recently successful snapshot
-
Indicates whether the cluster has a relatively recent successful snapshot.
-
-
External resources related to the cluster
-
links object
A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation
Hide links attribute Show links attribute object
-
-
-
-