Explain the shard allocations | Elasticsearch API documentation (original) (raw)

Dismiss highlight Show more

Query parameters

• If true, returns information about disk usage and shard sizes.
• If true, returns YES decisions in explanation.
• Period to wait for a connection to the master node.

application/json

Body

• Specifies the node ID or the name of the node to only explain a shard that is currently located on the specified node.
• If true, returns explanation for the primary shard for the given shard ID.
• Specifies the ID of the shard that you would like an explanation for.

Responses

• 200 application/json
  Hide response attributes Show response attributes object
  • A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  • Time unit for milliseconds
  • Values are yes, no, worse_balance, throttled, awaiting_info, allocation_delayed, no_valid_shard_copy, or no_attempt.
  • Values are yes, no, worse_balance, throttled, awaiting_info, allocation_delayed, no_valid_shard_copy, or no_attempt.
  • Values are yes, no, worse_balance, throttled, awaiting_info, allocation_delayed, no_valid_shard_copy, or no_attempt.
  • Hide can_rebalance_cluster_decisions attributes Show can_rebalance_cluster_decisions attributes object
    * Values are NO, YES, THROTTLE, or ALWAYS.
  • Values are yes, no, worse_balance, throttled, awaiting_info, allocation_delayed, no_valid_shard_copy, or no_attempt.
  • Hide can_remain_decisions attributes Show can_remain_decisions attributes object
    * Values are NO, YES, THROTTLE, or ALWAYS.
  • Values are yes, no, worse_balance, throttled, awaiting_info, allocation_delayed, no_valid_shard_copy, or no_attempt.
  • Hide cluster_info attributes Show cluster_info attributes object
    * Hide nodes attribute Show nodes attribute object
    * *
    object Additional properties
    Hide * attributes Show * attributes object
    * Hide least_available attributes Show least_available attributes object
    * Hide most_available attributes Show most_available attributes object
    * Hide shard_sizes attribute Show shard_sizes attribute object
    * *
    number Additional properties
    * Hide shard_data_set_sizes attribute Show shard_data_set_sizes attribute object
    * *
    string Additional properties
    * Hide shard_paths attribute Show shard_paths attribute object
    * *
    string Additional properties
    * Hide reserved_sizes attributes Show reserved_sizes attributes object
  • A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  • Time unit for milliseconds
  • Hide current_node attributes Show current_node attributes object
    * roles
    array[string] Required
    * @doc_id node-roles
    Values are master, data, data_cold, data_content, data_frozen, data_hot, data_warm, client, ingest, ml, voting_only, transform, remote_cluster_client, or coordinating_only.
    * Hide attributes attribute Show attributes attribute object
    * *
    string Additional properties
  • Hide node_allocation_decisions attributes Show node_allocation_decisions attributes object
    * Hide deciders attributes Show deciders attributes object
    * Values are NO, YES, THROTTLE, or ALWAYS.
    * Hide node_attributes attribute Show node_attributes attribute object
    * *
    string Additional properties
    * Values are yes, no, worse_balance, throttled, awaiting_info, allocation_delayed, no_valid_shard_copy, or no_attempt.
    * roles
    array[string] Required
    * @doc_id node-roles
    Values are master, data, data_cold, data_content, data_frozen, data_hot, data_warm, client, ingest, ml, voting_only, transform, remote_cluster_client, or coordinating_only.
    * Hide store attributes Show store attributes object
  • A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  • Time unit for milliseconds
  • Hide unassigned_info attributes Show unassigned_info attributes object
    * #### at string | number Required
    A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.
    Time unit for milliseconds
    * Values are INDEX_CREATED, CLUSTER_RECOVERED, INDEX_REOPENED, DANGLING_INDEX_IMPORTED, NEW_INDEX_RESTORED, EXISTING_INDEX_RESTORED, REPLICA_ADDED, ALLOCATION_FAILED, NODE_LEFT, REROUTE_CANCELLED, REINITIALIZED, REALLOCATED_REPLICA, PRIMARY_FAILED, FORCED_EMPTY_PRIMARY, or MANUAL_ALLOCATION.