It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.
The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
EnterpriseSearchInfo
editEnterpriseSearchInfo
editThe overview information for the Enterprise Search Server.
Properties
edit-
deployment_id
(string
) - The id of the deployment that this Enterprise Search belongs to.
-
elasticsearch_cluster
(TargetElasticsearchCluster
, required) - Information about the specified Elasticsearch cluster.
-
external_links
(array[
ExternalHyperlink
]
, required) - External resources related to the Enterprise Search
-
healthy
(boolean
, required) - Whether the Enterprise Search is healthy or not (one or more of the info subsections will have healthy: false)
-
id
(string
, required) - The id of the Enterprise Search
-
links
(map[string,
Hyperlink
]
) - A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation
-
metadata
(ClusterMetadataInfo
) - Information about the public and internal state, and the configuration settings of an Elasticsearch cluster.
-
name
(string
, required) - The name of the Enterprise Search
-
plan_info
(EnterpriseSearchPlansInfo
, required) - Information about current, pending, and past Enterprise Search Server plans.
-
region
(string
) - The region that this Enterprise Search belongs to. Only populated in SaaS or federated ECE.
-
settings
(EnterpriseSearchSettings
) - The cluster metadata settings for the Enterprise Search
-
status
(string
; allowed values: [initializing
,stopping
,stopped
,rebooting
,restarting
,reconfiguring
,started
], required) - Enterprise Search status
-
topology
(ClusterTopologyInfo
, required) -
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.
Example
edit{ "deployment_id" : "string", "elasticsearch_cluster" : { "elasticsearch_id" : "string", "links" : { "some_property" : { "need_elevated_permissions" : true } } }, "external_links" : [ { "id" : "string", "label" : "string", "uri" : "string" } ], "healthy" : true, "id" : "string", "links" : { "some_property" : { "need_elevated_permissions" : true } }, "metadata" : { "aliased_endpoint" : "string", "aliased_url" : "string", "cloud_id" : "string", "endpoint" : "string", "last_modified" : "2019-01-01T00:00:00Z", "ports" : { "http" : 0, "https" : 0, "transport_passthrough" : 0 }, "raw" : {}, "service_url" : "string", "services_urls" : [ { "service" : "string", "url" : "string" } ], "version" : 0 }, "name" : "string", "plan_info" : { "current" : { "attempt_end_time" : "2019-01-01T00:00:00Z", "attempt_start_time" : "2019-01-01T00:00:00Z", "healthy" : true, "plan" : { "cluster_topology" : [ { "allocator_filter" : {}, "enterprise_search" : { "docker_image" : "string", "system_settings" : { "elasticsearch_password" : "string", "elasticsearch_url" : "string", "elasticsearch_username" : "string", "secret_session_key" : "string" }, "user_settings_json" : {}, "user_settings_override_json" : {}, "user_settings_override_yaml" : "string", "user_settings_yaml" : "string", "version" : "string" }, "instance_configuration_id" : "string", "memory_per_node" : {}, "node_configuration" : "string", "node_count_per_zone" : {}, "node_type" : { "appserver" : true, "connector" : true, "worker" : true }, "size" : { "resource" : "string", "value" : 0 }, "zone_count" : 0 } ], "enterprise_search" : { "docker_image" : "string", "system_settings" : { "elasticsearch_password" : "string", "elasticsearch_url" : "string", "elasticsearch_username" : "string", "secret_session_key" : "string" }, "user_settings_json" : {}, "user_settings_override_json" : {}, "user_settings_override_yaml" : "string", "user_settings_yaml" : "string", "version" : "string" }, "transient" : { "plan_configuration" : { "calm_wait_time" : 0, "cluster_reboot" : "string", "extended_maintenance" : true, "move_allocators" : [ { "allocator_down" : true, "from" : "string", "to" : [ "string" ] } ], "move_instances" : [ { "from" : "string", "instance_down" : true, "to" : [ "string" ] } ], "preferred_allocators" : [ "string" ], "reallocate_instances" : true, "timeout" : 0 }, "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" } }, "healthy" : true, "history" : [ { "attempt_end_time" : "2019-01-01T00:00:00Z", "attempt_start_time" : "2019-01-01T00:00:00Z", "healthy" : true, "plan" : { "cluster_topology" : [ { "allocator_filter" : {}, "enterprise_search" : { "docker_image" : "string", "system_settings" : { "elasticsearch_password" : "string", "elasticsearch_url" : "string", "elasticsearch_username" : "string", "secret_session_key" : "string" }, "user_settings_json" : {}, "user_settings_override_json" : {}, "user_settings_override_yaml" : "string", "user_settings_yaml" : "string", "version" : "string" }, "instance_configuration_id" : "string", "memory_per_node" : {}, "node_configuration" : "string", "node_count_per_zone" : {}, "node_type" : { "appserver" : true, "connector" : true, "worker" : true }, "size" : { "resource" : "string", "value" : 0 }, "zone_count" : 0 } ], "enterprise_search" : { "docker_image" : "string", "system_settings" : { "elasticsearch_password" : "string", "elasticsearch_url" : "string", "elasticsearch_username" : "string", "secret_session_key" : "string" }, "user_settings_json" : {}, "user_settings_override_json" : {}, "user_settings_override_yaml" : "string", "user_settings_yaml" : "string", "version" : "string" }, "transient" : { "plan_configuration" : { "calm_wait_time" : 0, "cluster_reboot" : "string", "extended_maintenance" : true, "move_allocators" : [ { "allocator_down" : true, "from" : "string", "to" : [ "string" ] } ], "move_instances" : [ { "from" : "string", "instance_down" : true, "to" : [ "string" ] } ], "preferred_allocators" : [ "string" ], "reallocate_instances" : true, "timeout" : 0 }, "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" } } ], "pending" : { "attempt_end_time" : "2019-01-01T00:00:00Z", "attempt_start_time" : "2019-01-01T00:00:00Z", "healthy" : true, "plan" : { "cluster_topology" : [ { "allocator_filter" : {}, "enterprise_search" : { "docker_image" : "string", "system_settings" : { "elasticsearch_password" : "string", "elasticsearch_url" : "string", "elasticsearch_username" : "string", "secret_session_key" : "string" }, "user_settings_json" : {}, "user_settings_override_json" : {}, "user_settings_override_yaml" : "string", "user_settings_yaml" : "string", "version" : "string" }, "instance_configuration_id" : "string", "memory_per_node" : {}, "node_configuration" : "string", "node_count_per_zone" : {}, "node_type" : { "appserver" : true, "connector" : true, "worker" : true }, "size" : { "resource" : "string", "value" : 0 }, "zone_count" : 0 } ], "enterprise_search" : { "docker_image" : "string", "system_settings" : { "elasticsearch_password" : "string", "elasticsearch_url" : "string", "elasticsearch_username" : "string", "secret_session_key" : "string" }, "user_settings_json" : {}, "user_settings_override_json" : {}, "user_settings_override_yaml" : "string", "user_settings_yaml" : "string", "version" : "string" }, "transient" : { "plan_configuration" : { "calm_wait_time" : 0, "cluster_reboot" : "string", "extended_maintenance" : true, "move_allocators" : [ { "allocator_down" : true, "from" : "string", "to" : [ "string" ] } ], "move_instances" : [ { "from" : "string", "instance_down" : true, "to" : [ "string" ] } ], "preferred_allocators" : [ "string" ], "reallocate_instances" : true, "timeout" : 0 }, "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" } } }, "region" : "string", "settings" : { "metadata" : { "contact_email" : "string", "hidden" : true, "name" : "string", "organization_id" : "string", "owner_id" : "string", "resources" : { "cpu" : { "boost" : true, "hard_limit" : true } }, "subscription_level" : "string", "system_owned" : true } }, "status" : "string", "topology" : { "healthy" : true, "instances" : [ { "allocator_id" : "string", "container_started" : true, "disk" : { "disk_space_available" : 0, "disk_space_used" : 0, "storage_multiplier" : 0.1 }, "healthy" : true, "instance_configuration" : { "id" : "string", "name" : "string", "resource" : "string" }, "instance_name" : "string", "maintenance_mode" : true, "memory" : { "instance_capacity" : 0, "instance_capacity_planned" : 0, "memory_pressure" : 0, "native_memory_pressure" : 0 }, "node_roles" : [ "string" ], "service_id" : "string", "service_roles" : [ "string" ], "service_running" : true, "service_version" : "string", "zone" : "string" } ] } }