ElasticsearchClusterPlansInfo
editElasticsearchClusterPlansInfo
editInformation about the current, pending, and past Elasticsearch cluster plans.
Properties
edit-
current(ElasticsearchClusterPlanInfo) - Information about the Elasticsearch cluster plan.
-
healthy(boolean, required) - Whether the plan situation is healthy (if unhealthy, means the last plan attempt failed)
-
history(array[ElasticsearchClusterPlanInfo], required) -
pending(ElasticsearchClusterPlanInfo) - Information about the Elasticsearch cluster plan.
Example
edit{
"current" : {
"attempt_end_time" : "2019-01-01T00:00:00Z",
"attempt_start_time" : "2019-01-01T00:00:00Z",
"error" : {
"details" : {
"some_property" : "string"
},
"failure_type" : "string",
"message" : "string",
"timestamp" : "2019-01-01T00:00:00Z"
},
"healthy" : true,
"plan" : {
"autoscaling_enabled" : true,
"cluster_topology" : [
{
"autoscaling_max" : {
"resource" : "string",
"value" : 0
},
"autoscaling_min" : {
"resource" : "string",
"value" : 0
},
"autoscaling_policy_override_json" : {},
"autoscaling_tier_override" : true,
"elasticsearch" : {
"curation" : {
"from_instance_configuration_id" : "string",
"to_instance_configuration_id" : "string"
},
"docker_image" : "string",
"enabled_built_in_plugins" : [
"string"
],
"node_attributes" : {
"some_property" : "string"
},
"system_settings" : {
"auto_create_index" : true,
"default_shards_per_index" : 0,
"destructive_requires_name" : true,
"enable_close_index" : true,
"monitoring_collection_interval" : 0,
"monitoring_history_duration" : "string",
"reindex_whitelist" : [
"string"
],
"scripting" : {
"expressions_enabled" : true,
"file" : {
"enabled" : true,
"sandbox_mode" : true
},
"inline" : {
"enabled" : true,
"sandbox_mode" : true
},
"mustache_enabled" : true,
"painless_enabled" : true,
"stored" : {
"enabled" : true,
"sandbox_mode" : true
}
},
"watcher_trigger_engine" : "string"
},
"user_bundles" : [
{
"elasticsearch_version" : "string",
"name" : "string",
"url" : "string"
}
],
"user_plugins" : [
{
"elasticsearch_version" : "string",
"name" : "string",
"url" : "string"
}
],
"user_settings_json" : {},
"user_settings_override_json" : {},
"user_settings_override_yaml" : "string",
"user_settings_yaml" : "string",
"version" : "string"
},
"id" : "string",
"instance_configuration_id" : "string",
"instance_configuration_version" : 0,
"memory_per_node" : 0,
"node_count_per_zone" : 0,
"node_roles" : [
"string"
],
"node_type" : {
"data" : true,
"ingest" : true,
"master" : true,
"ml" : true
},
"size" : {
"resource" : "string",
"value" : 0
},
"topology_element_control" : {
"min" : {
"resource" : "string",
"value" : 0
}
},
"zone_count" : 0
}
],
"deployment_template" : {
"id" : "string",
"version" : "string"
},
"elasticsearch" : {
"curation" : {
"from_instance_configuration_id" : "string",
"to_instance_configuration_id" : "string"
},
"docker_image" : "string",
"enabled_built_in_plugins" : [
"string"
],
"node_attributes" : {
"some_property" : "string"
},
"system_settings" : {
"auto_create_index" : true,
"default_shards_per_index" : 0,
"destructive_requires_name" : true,
"enable_close_index" : true,
"monitoring_collection_interval" : 0,
"monitoring_history_duration" : "string",
"reindex_whitelist" : [
"string"
],
"scripting" : {
"expressions_enabled" : true,
"file" : {
"enabled" : true,
"sandbox_mode" : true
},
"inline" : {
"enabled" : true,
"sandbox_mode" : true
},
"mustache_enabled" : true,
"painless_enabled" : true,
"stored" : {
"enabled" : true,
"sandbox_mode" : true
}
},
"watcher_trigger_engine" : "string"
},
"user_bundles" : [
{
"elasticsearch_version" : "string",
"name" : "string",
"url" : "string"
}
],
"user_plugins" : [
{
"elasticsearch_version" : "string",
"name" : "string",
"url" : "string"
}
],
"user_settings_json" : {},
"user_settings_override_json" : {},
"user_settings_override_yaml" : "string",
"user_settings_yaml" : "string",
"version" : "string"
},
"transient" : {
"cluster_settings_json" : {},
"plan_configuration" : {
"calm_wait_time" : 0,
"cluster_reboot" : "string",
"extended_maintenance" : true,
"max_snapshot_age" : 0,
"max_snapshot_attempts" : 0,
"move_allocators" : [
{
"allocator_down" : true,
"from" : "string",
"to" : [
"string"
]
}
],
"move_instances" : [
{
"from" : "string",
"instance_down" : true,
"to" : [
"string"
]
}
],
"move_only" : true,
"override_failsafe" : true,
"preferred_allocator_tags" : {
"some_property" : "string"
},
"preferred_allocators" : [
"string"
],
"reallocate_instances" : true,
"skip_data_migration" : true,
"skip_post_upgrade_steps" : true,
"skip_snapshot" : true,
"skip_snapshot_post_major_upgrade" : true,
"skip_upgrade_checker" : true,
"timeout" : 0
},
"remote_clusters" : {
"resources" : [
{
"alias" : "string",
"deployment_id" : "string",
"elasticsearch_ref_id" : "string",
"info" : {
"compatible" : true,
"connected" : true,
"healthy" : true,
"trusted" : true,
"trusted_back" : true
},
"skip_unavailable" : true
}
]
},
"restore_snapshot" : {
"repository_config" : {
"raw_settings" : {}
},
"repository_name" : "string",
"restore_payload" : {
"indices" : [
"string"
],
"raw_settings" : {}
},
"snapshot_name" : "string",
"source_cluster_id" : "string",
"strategy" : "string"
},
"strategy" : {
"autodetect" : {},
"grow_and_shrink" : {},
"rolling" : {
"allow_inline_resize" : true,
"group_by" : "string",
"shard_init_wait_time" : 0,
"skip_synced_flush" : true
},
"rolling_grow_and_shrink" : {}
}
}
},
"plan_attempt_id" : "string",
"plan_attempt_log" : [
{
"completed" : "2019-01-01T00:00:00Z",
"duration_in_millis" : 0,
"info_log" : [
{
"delta_in_millis" : 0,
"details" : {
"some_property" : "string"
},
"failure_type" : "string",
"internal_details" : {
"some_property" : "string"
},
"message" : "string",
"stage" : "string",
"timestamp" : "2019-01-01T00:00:00Z"
}
],
"stage" : "string",
"started" : "2019-01-01T00:00:00Z",
"status" : "string",
"step_id" : "string"
}
],
"plan_attempt_name" : "string",
"plan_end_time" : "2019-01-01T00:00:00Z",
"source" : {
"action" : "string",
"admin_id" : "string",
"date" : "2019-01-01T00:00:00Z",
"facilitator" : "string",
"remote_addresses" : [
"string"
],
"user_id" : "string"
},
"warnings" : [
{
"code" : "string",
"message" : "string",
"step_id" : "string"
}
]
},
"healthy" : true,
"history" : [
{
"attempt_end_time" : "2019-01-01T00:00:00Z",
"attempt_start_time" : "2019-01-01T00:00:00Z",
"error" : {
"details" : {
"some_property" : "string"
},
"failure_type" : "string",
"message" : "string",
"timestamp" : "2019-01-01T00:00:00Z"
},
"healthy" : true,
"plan" : {
"autoscaling_enabled" : true,
"cluster_topology" : [
{
"autoscaling_max" : {
"resource" : "string",
"value" : 0
},
"autoscaling_min" : {
"resource" : "string",
"value" : 0
},
"autoscaling_policy_override_json" : {},
"autoscaling_tier_override" : true,
"elasticsearch" : {
"curation" : {
"from_instance_configuration_id" : "string",
"to_instance_configuration_id" : "string"
},
"docker_image" : "string",
"enabled_built_in_plugins" : [
"string"
],
"node_attributes" : {
"some_property" : "string"
},
"system_settings" : {
"auto_create_index" : true,
"default_shards_per_index" : 0,
"destructive_requires_name" : true,
"enable_close_index" : true,
"monitoring_collection_interval" : 0,
"monitoring_history_duration" : "string",
"reindex_whitelist" : [
"string"
],
"scripting" : {
"expressions_enabled" : true,
"file" : {
"enabled" : true,
"sandbox_mode" : true
},
"inline" : {
"enabled" : true,
"sandbox_mode" : true
},
"mustache_enabled" : true,
"painless_enabled" : true,
"stored" : {
"enabled" : true,
"sandbox_mode" : true
}
},
"watcher_trigger_engine" : "string"
},
"user_bundles" : [
{
"elasticsearch_version" : "string",
"name" : "string",
"url" : "string"
}
],
"user_plugins" : [
{
"elasticsearch_version" : "string",
"name" : "string",
"url" : "string"
}
],
"user_settings_json" : {},
"user_settings_override_json" : {},
"user_settings_override_yaml" : "string",
"user_settings_yaml" : "string",
"version" : "string"
},
"id" : "string",
"instance_configuration_id" : "string",
"instance_configuration_version" : 0,
"memory_per_node" : 0,
"node_count_per_zone" : 0,
"node_roles" : [
"string"
],
"node_type" : {
"data" : true,
"ingest" : true,
"master" : true,
"ml" : true
},
"size" : {
"resource" : "string",
"value" : 0
},
"topology_element_control" : {
"min" : {
"resource" : "string",
"value" : 0
}
},
"zone_count" : 0
}
],
"deployment_template" : {
"id" : "string",
"version" : "string"
},
"elasticsearch" : {
"curation" : {
"from_instance_configuration_id" : "string",
"to_instance_configuration_id" : "string"
},
"docker_image" : "string",
"enabled_built_in_plugins" : [
"string"
],
"node_attributes" : {
"some_property" : "string"
},
"system_settings" : {
"auto_create_index" : true,
"default_shards_per_index" : 0,
"destructive_requires_name" : true,
"enable_close_index" : true,
"monitoring_collection_interval" : 0,
"monitoring_history_duration" : "string",
"reindex_whitelist" : [
"string"
],
"scripting" : {
"expressions_enabled" : true,
"file" : {
"enabled" : true,
"sandbox_mode" : true
},
"inline" : {
"enabled" : true,
"sandbox_mode" : true
},
"mustache_enabled" : true,
"painless_enabled" : true,
"stored" : {
"enabled" : true,
"sandbox_mode" : true
}
},
"watcher_trigger_engine" : "string"
},
"user_bundles" : [
{
"elasticsearch_version" : "string",
"name" : "string",
"url" : "string"
}
],
"user_plugins" : [
{
"elasticsearch_version" : "string",
"name" : "string",
"url" : "string"
}
],
"user_settings_json" : {},
"user_settings_override_json" : {},
"user_settings_override_yaml" : "string",
"user_settings_yaml" : "string",
"version" : "string"
},
"transient" : {
"cluster_settings_json" : {},
"plan_configuration" : {
"calm_wait_time" : 0,
"cluster_reboot" : "string",
"extended_maintenance" : true,
"max_snapshot_age" : 0,
"max_snapshot_attempts" : 0,
"move_allocators" : [
{
"allocator_down" : true,
"from" : "string",
"to" : [
"string"
]
}
],
"move_instances" : [
{
"from" : "string",
"instance_down" : true,
"to" : [
"string"
]
}
],
"move_only" : true,
"override_failsafe" : true,
"preferred_allocator_tags" : {
"some_property" : "string"
},
"preferred_allocators" : [
"string"
],
"reallocate_instances" : true,
"skip_data_migration" : true,
"skip_post_upgrade_steps" : true,
"skip_snapshot" : true,
"skip_snapshot_post_major_upgrade" : true,
"skip_upgrade_checker" : true,
"timeout" : 0
},
"remote_clusters" : {
"resources" : [
{
"alias" : "string",
"deployment_id" : "string",
"elasticsearch_ref_id" : "string",
"info" : {
"compatible" : true,
"connected" : true,
"healthy" : true,
"trusted" : true,
"trusted_back" : true
},
"skip_unavailable" : true
}
]
},
"restore_snapshot" : {
"repository_config" : {
"raw_settings" : {}
},
"repository_name" : "string",
"restore_payload" : {
"indices" : [
"string"
],
"raw_settings" : {}
},
"snapshot_name" : "string",
"source_cluster_id" : "string",
"strategy" : "string"
},
"strategy" : {
"autodetect" : {},
"grow_and_shrink" : {},
"rolling" : {
"allow_inline_resize" : true,
"group_by" : "string",
"shard_init_wait_time" : 0,
"skip_synced_flush" : true
},
"rolling_grow_and_shrink" : {}
}
}
},
"plan_attempt_id" : "string",
"plan_attempt_log" : [
{
"completed" : "2019-01-01T00:00:00Z",
"duration_in_millis" : 0,
"info_log" : [
{
"delta_in_millis" : 0,
"details" : {
"some_property" : "string"
},
"failure_type" : "string",
"internal_details" : {
"some_property" : "string"
},
"message" : "string",
"stage" : "string",
"timestamp" : "2019-01-01T00:00:00Z"
}
],
"stage" : "string",
"started" : "2019-01-01T00:00:00Z",
"status" : "string",
"step_id" : "string"
}
],
"plan_attempt_name" : "string",
"plan_end_time" : "2019-01-01T00:00:00Z",
"source" : {
"action" : "string",
"admin_id" : "string",
"date" : "2019-01-01T00:00:00Z",
"facilitator" : "string",
"remote_addresses" : [
"string"
],
"user_id" : "string"
},
"warnings" : [
{
"code" : "string",
"message" : "string",
"step_id" : "string"
}
]
}
],
"pending" : {
"attempt_end_time" : "2019-01-01T00:00:00Z",
"attempt_start_time" : "2019-01-01T00:00:00Z",
"error" : {
"details" : {
"some_property" : "string"
},
"failure_type" : "string",
"message" : "string",
"timestamp" : "2019-01-01T00:00:00Z"
},
"healthy" : true,
"plan" : {
"autoscaling_enabled" : true,
"cluster_topology" : [
{
"autoscaling_max" : {
"resource" : "string",
"value" : 0
},
"autoscaling_min" : {
"resource" : "string",
"value" : 0
},
"autoscaling_policy_override_json" : {},
"autoscaling_tier_override" : true,
"elasticsearch" : {
"curation" : {
"from_instance_configuration_id" : "string",
"to_instance_configuration_id" : "string"
},
"docker_image" : "string",
"enabled_built_in_plugins" : [
"string"
],
"node_attributes" : {
"some_property" : "string"
},
"system_settings" : {
"auto_create_index" : true,
"default_shards_per_index" : 0,
"destructive_requires_name" : true,
"enable_close_index" : true,
"monitoring_collection_interval" : 0,
"monitoring_history_duration" : "string",
"reindex_whitelist" : [
"string"
],
"scripting" : {
"expressions_enabled" : true,
"file" : {
"enabled" : true,
"sandbox_mode" : true
},
"inline" : {
"enabled" : true,
"sandbox_mode" : true
},
"mustache_enabled" : true,
"painless_enabled" : true,
"stored" : {
"enabled" : true,
"sandbox_mode" : true
}
},
"watcher_trigger_engine" : "string"
},
"user_bundles" : [
{
"elasticsearch_version" : "string",
"name" : "string",
"url" : "string"
}
],
"user_plugins" : [
{
"elasticsearch_version" : "string",
"name" : "string",
"url" : "string"
}
],
"user_settings_json" : {},
"user_settings_override_json" : {},
"user_settings_override_yaml" : "string",
"user_settings_yaml" : "string",
"version" : "string"
},
"id" : "string",
"instance_configuration_id" : "string",
"instance_configuration_version" : 0,
"memory_per_node" : 0,
"node_count_per_zone" : 0,
"node_roles" : [
"string"
],
"node_type" : {
"data" : true,
"ingest" : true,
"master" : true,
"ml" : true
},
"size" : {
"resource" : "string",
"value" : 0
},
"topology_element_control" : {
"min" : {
"resource" : "string",
"value" : 0
}
},
"zone_count" : 0
}
],
"deployment_template" : {
"id" : "string",
"version" : "string"
},
"elasticsearch" : {
"curation" : {
"from_instance_configuration_id" : "string",
"to_instance_configuration_id" : "string"
},
"docker_image" : "string",
"enabled_built_in_plugins" : [
"string"
],
"node_attributes" : {
"some_property" : "string"
},
"system_settings" : {
"auto_create_index" : true,
"default_shards_per_index" : 0,
"destructive_requires_name" : true,
"enable_close_index" : true,
"monitoring_collection_interval" : 0,
"monitoring_history_duration" : "string",
"reindex_whitelist" : [
"string"
],
"scripting" : {
"expressions_enabled" : true,
"file" : {
"enabled" : true,
"sandbox_mode" : true
},
"inline" : {
"enabled" : true,
"sandbox_mode" : true
},
"mustache_enabled" : true,
"painless_enabled" : true,
"stored" : {
"enabled" : true,
"sandbox_mode" : true
}
},
"watcher_trigger_engine" : "string"
},
"user_bundles" : [
{
"elasticsearch_version" : "string",
"name" : "string",
"url" : "string"
}
],
"user_plugins" : [
{
"elasticsearch_version" : "string",
"name" : "string",
"url" : "string"
}
],
"user_settings_json" : {},
"user_settings_override_json" : {},
"user_settings_override_yaml" : "string",
"user_settings_yaml" : "string",
"version" : "string"
},
"transient" : {
"cluster_settings_json" : {},
"plan_configuration" : {
"calm_wait_time" : 0,
"cluster_reboot" : "string",
"extended_maintenance" : true,
"max_snapshot_age" : 0,
"max_snapshot_attempts" : 0,
"move_allocators" : [
{
"allocator_down" : true,
"from" : "string",
"to" : [
"string"
]
}
],
"move_instances" : [
{
"from" : "string",
"instance_down" : true,
"to" : [
"string"
]
}
],
"move_only" : true,
"override_failsafe" : true,
"preferred_allocator_tags" : {
"some_property" : "string"
},
"preferred_allocators" : [
"string"
],
"reallocate_instances" : true,
"skip_data_migration" : true,
"skip_post_upgrade_steps" : true,
"skip_snapshot" : true,
"skip_snapshot_post_major_upgrade" : true,
"skip_upgrade_checker" : true,
"timeout" : 0
},
"remote_clusters" : {
"resources" : [
{
"alias" : "string",
"deployment_id" : "string",
"elasticsearch_ref_id" : "string",
"info" : {
"compatible" : true,
"connected" : true,
"healthy" : true,
"trusted" : true,
"trusted_back" : true
},
"skip_unavailable" : true
}
]
},
"restore_snapshot" : {
"repository_config" : {
"raw_settings" : {}
},
"repository_name" : "string",
"restore_payload" : {
"indices" : [
"string"
],
"raw_settings" : {}
},
"snapshot_name" : "string",
"source_cluster_id" : "string",
"strategy" : "string"
},
"strategy" : {
"autodetect" : {},
"grow_and_shrink" : {},
"rolling" : {
"allow_inline_resize" : true,
"group_by" : "string",
"shard_init_wait_time" : 0,
"skip_synced_flush" : true
},
"rolling_grow_and_shrink" : {}
}
}
},
"plan_attempt_id" : "string",
"plan_attempt_log" : [
{
"completed" : "2019-01-01T00:00:00Z",
"duration_in_millis" : 0,
"info_log" : [
{
"delta_in_millis" : 0,
"details" : {
"some_property" : "string"
},
"failure_type" : "string",
"internal_details" : {
"some_property" : "string"
},
"message" : "string",
"stage" : "string",
"timestamp" : "2019-01-01T00:00:00Z"
}
],
"stage" : "string",
"started" : "2019-01-01T00:00:00Z",
"status" : "string",
"step_id" : "string"
}
],
"plan_attempt_name" : "string",
"plan_end_time" : "2019-01-01T00:00:00Z",
"source" : {
"action" : "string",
"admin_id" : "string",
"date" : "2019-01-01T00:00:00Z",
"facilitator" : "string",
"remote_addresses" : [
"string"
],
"user_id" : "string"
},
"warnings" : [
{
"code" : "string",
"message" : "string",
"step_id" : "string"
}
]
}
}