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

ElasticsearchShardsInfo

edit

Information about the shards and replicas that comprise the Elasticsearch indices.

Properties

edit
available_shards (array[ElasticsearchShardElement], required)
healthy (boolean, required)
Whether the shard situation is healthy (any unavailable shards is unhealthy)
unavailable_replicas (array[ElasticsearchReplicaElement], required)
unavailable_shards (array[ElasticsearchShardElement], required)

Example

edit
{
   "available_shards" : [
      {
         "instance_name" : "string",
         "shard_count" : 0
      }
   ],
   "healthy" : true,
   "unavailable_replicas" : [
      {
         "instance_name" : "string",
         "replica_count" : 0
      }
   ],
   "unavailable_shards" : [
      {
         "instance_name" : "string",
         "shard_count" : 0
      }
   ]
}