Query parameters

• include_disk_info boolean

  If true, returns information about disk usage and shard sizes.

• include_yes_decisions boolean

  If true, returns YES decisions in explanation.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • allocate_explanation string
  • allocation_delay string

    A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

  • allocation_delay_in_millis number

    Time unit for milliseconds

  • can_allocate string

    Values are yes, no, worse_balance, throttled, awaiting_info, allocation_delayed, no_valid_shard_copy, or no_attempt.

  • can_move_to_other_node string

    Values are yes, no, worse_balance, throttled, awaiting_info, allocation_delayed, no_valid_shard_copy, or no_attempt.

  • can_rebalance_cluster string

    Values are yes, no, worse_balance, throttled, awaiting_info, allocation_delayed, no_valid_shard_copy, or no_attempt.

  • can_rebalance_cluster_decisions array[object]
    Hide can_rebalance_cluster_decisions attributes Show can_rebalance_cluster_decisions attributes object

    • decider string Required
    • decision string Required

      Values are NO, YES, THROTTLE, or ALWAYS.

    • explanation string Required
  • can_rebalance_to_other_node string

    Values are yes, no, worse_balance, throttled, awaiting_info, allocation_delayed, no_valid_shard_copy, or no_attempt.

  • can_remain_decisions array[object]
    Hide can_remain_decisions attributes Show can_remain_decisions attributes object

    • decider string Required
    • decision string Required

      Values are NO, YES, THROTTLE, or ALWAYS.

    • explanation string Required
  • can_remain_on_current_node string

    Values are yes, no, worse_balance, throttled, awaiting_info, allocation_delayed, no_valid_shard_copy, or no_attempt.

  • cluster_info object
    Hide cluster_info attributes Show cluster_info attributes object

    • nodes object Required
      Hide nodes attribute Show nodes attribute object

      • * object Additional properties
        Hide * attributes Show * attributes object

        • node_name string Required
        • least_available object Required
          Hide least_available attributes Show least_available attributes object

          • path string Required
          • total_bytes number Required
          • used_bytes number Required
          • free_bytes number Required
          • free_disk_percent number Required
          • used_disk_percent number Required
        • most_available object Required
          Hide most_available attributes Show most_available attributes object

          • path string Required
          • total_bytes number Required
          • used_bytes number Required
          • free_bytes number Required
          • free_disk_percent number Required
          • used_disk_percent number Required
    • shard_sizes object Required
      Hide shard_sizes attribute Show shard_sizes attribute object

      • * number Additional properties
    • shard_data_set_sizes object
      Hide shard_data_set_sizes attribute Show shard_data_set_sizes attribute object

      • * string Additional properties
    • shard_paths object Required
      Hide shard_paths attribute Show shard_paths attribute object

      • * string Additional properties
    • reserved_sizes array[object] Required
      Hide reserved_sizes attributes Show reserved_sizes attributes object

      • node_id string Required
      • path string Required
      • total number Required
      • shards array[string] Required
  • configured_delay string

    A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

  • configured_delay_in_millis number

    Time unit for milliseconds

  • current_node object
    Hide current_node attributes Show current_node attributes object

    • id string Required
    • name string Required
    • 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.

    • attributes object Required
      Hide attributes attribute Show attributes attribute object

      • * string Additional properties
    • transport_address string Required
    • weight_ranking number Required
  • current_state string Required
  • index string Required
  • move_explanation string
  • node_allocation_decisions array[object]
    Hide node_allocation_decisions attributes Show node_allocation_decisions attributes object

    • deciders array[object] Required
      Hide deciders attributes Show deciders attributes object

      • decider string Required
      • decision string Required

        Values are NO, YES, THROTTLE, or ALWAYS.

      • explanation string Required
    • node_attributes object Required
      Hide node_attributes attribute Show node_attributes attribute object

      • * string Additional properties
    • node_decision string Required

      Values are yes, no, worse_balance, throttled, awaiting_info, allocation_delayed, no_valid_shard_copy, or no_attempt.

    • node_id string Required
    • node_name string Required
    • 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.

    • store object
      Hide store attributes Show store attributes object

      • allocation_id string Required
      • found boolean Required
      • in_sync boolean Required
      • matching_size_in_bytes number Required
      • matching_sync_id boolean Required
      • store_exception string Required
    • transport_address string Required
    • weight_ranking number Required
  • primary boolean Required
  • rebalance_explanation string
  • remaining_delay string

    A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

  • remaining_delay_in_millis number

    Time unit for milliseconds

  • shard number Required
  • unassigned_info object
    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.

      One of:

      _types:DateTime string _types:UnitMillis number

      Time unit for milliseconds

    • last_allocation_status string
    • reason string Required

      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.

    • details string
    • failed_allocation_attempts number
    • delayed boolean
    • allocation_status string
  • note string