AllocatedInstanceStatus

edit

`AllocatedInstanceStatus`

edit

The status of the allocated Kibana instance or APM Server.

Properties

edit

cluster_healthy (boolean): Indicates whether the cluster the instance belongs to is healthy
cluster_id (string, required): Identifier for the cluster this instance belongs
cluster_name (string): Name of cluster this instance belongs, if available
cluster_type (string; allowed values: [elasticsearch, kibana, apm, integrations_server, appsearch, enterprise_search], required): Type of instance that is running
deployment_id (string): The id of the deployment this cluster belongs to.
healthy (boolean): Indicates whether the instance is healthy
instance_configuration_id (string): The instance configuration id of this instance
instance_name (string, required): Instance ID of the instance
moving (boolean): Indicates whether the instance is vacating away from this allocator. Note that this is currently not populated when returned from the search endpoint.
node_memory (integer as int32, required): Memory assigned to this instance
plans_info (AllocatedInstancePlansInfo): The plans associated with the current instance. Note that this is currently not populated when returned from the search endpoint.

Example

edit

{
   "cluster_healthy" : true,
   "cluster_id" : "string",
   "cluster_name" : "string",
   "cluster_type" : "string",
   "deployment_id" : "string",
   "healthy" : true,
   "instance_configuration_id" : "string",
   "instance_name" : "string",
   "moving" : true,
   "node_memory" : 0,
   "plans_info" : {
      "pending" : true,
      "version" : "string",
      "zone_count" : 0
   }
}

« AllocatedInstancePlansInfo AllocatorBuildInfo »