IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« ClusterInstanceDiskInfo ClusterInstanceMemoryInfo »

› › › ›

ClusterInstanceInfo

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

`ClusterInstanceInfo`

edit

Information about each Kibana instance and APM Server in the Elasticsearch cluster.

Properties

edit

allocator_id (string): The id of the allocator on which this instance is running (if the container is started or starting)
container_started (boolean, required): Whether the container has started (does not tell you anything about the service -ie Elasticsearch- running inside the container)
disk (ClusterInstanceDiskInfo): Information about the use and storage capacity of a Kibana instance or APM Server.
healthy (boolean, required): Whether the instance is healthy (ie started and running)
instance_configuration (ClusterInstanceConfigurationInfo): Information about a configuration that creates a Kibana instance or APM Server.
instance_name (string, required): Whether the instance is healthy (ie started and running)
maintenance_mode (boolean, required): Whether the service is is maintenance mode (meaning that the proxy is not routing external traffic to it)
memory (ClusterInstanceMemoryInfo): Information about the memory capacity and use of the Kibana instance or APM Server.
node_roles (array[string]): A list of the node roles assigned to the service running in the instance. Currently populated only for Elasticsearch.
service_id (string): The service-specific (eg Elasticsearch) id of the node, if available
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
service_running (boolean, required): Whether the service launched inside the container -ie Elasticsearch- is actually running
service_version (string): The version of the service that the instance is running (eg Elasticsearch or Kibana), if available
zone (string): The zone in which this instance is being allocated

Example

edit

{
   "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"
}

« ClusterInstanceDiskInfo ClusterInstanceMemoryInfo »