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.
KibanaClusterInfo
editKibanaClusterInfo
editThe top-level object information for a Kibana instance.
Properties
edit-
cluster_id(string, required) - The id of the cluster
-
cluster_name(string, required) - The name of the cluster
-
deployment_id(string) - The id of the deployment to which this Kibana Server belongs to.
-
elasticsearch_cluster(TargetElasticsearchCluster, required) - Information about the specified Elasticsearch cluster.
-
external_links(array[ExternalHyperlink], required) - External resources related to the cluster
-
healthy(boolean, required) - Whether the cluster is healthy or not (one or more of the info subsections will have healthy: false)
-
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, required) - Information about the public and internal state, and the configuration settings of an Elasticsearch cluster.
-
plan_info(KibanaClusterPlansInfo, required) - Information about the current, pending, or past Kibana instance plans.
-
region(string) - The region that this cluster belongs to. Only populated in SaaS or federated ECE.
-
settings(KibanaClusterSettings) - The cluster metadata settings for a kibana cluster
-
status(string; allowed values: [initializing,stopping,stopped,rebooting,restarting,reconfiguring,started], required) - Cluster status
-
topology(ClusterTopologyInfo, required) -
The topology for Elasticsearch clusters, multiple Kibana instances, or multiple APM Servers. The
ClusterTopologyInfoalso includes the instances and containers, and where they are located.
Example
edit{
"cluster_id" : "string",
"cluster_name" : "string",
"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,
"links" : {
"some_property" : null
},
"metadata" : {
"cloud_id" : "string",
"endpoint" : "string",
"last_modified" : "2019-01-01T00:00:00Z",
"ports" : {
"http" : 0,
"https" : 0
},
"raw" : {},
"version" : 0
},
"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" : {},
"instance_configuration_id" : "string",
"kibana" : {
"docker_image" : "string",
"system_settings" : {
"elasticsearch_password" : "string",
"elasticsearch_url" : "string",
"elasticsearch_username" : "string"
},
"user_settings_json" : {},
"user_settings_override_json" : {},
"user_settings_override_yaml" : "string",
"user_settings_yaml" : "string",
"version" : "string"
},
"memory_per_node" : 0,
"node_configuration" : "string",
"node_count_per_zone" : 0,
"size" : {
"resource" : "string",
"value" : 0
},
"zone_count" : 0
}
],
"kibana" : null,
"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" : {}
}
},
"zone_count" : 0
},
"plan_attempt_id" : "string",
"plan_attempt_log" : [
{
"completed" : "2019-01-01T00:00:00Z",
"duration_in_millis" : 0,
"info_log" : [
{
"delta_in_millis" : 0,
"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" : [
null
],
"pending" : null
},
"region" : "string",
"settings" : {
"metadata" : {
"contact_email" : "string",
"hidden" : true,
"name" : "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
},
"service_id" : "string",
"service_roles" : [
"string"
],
"service_running" : true,
"service_version" : "string",
"zone" : "string"
}
]
}
}