Path parameters

• id string Required

  The ID of the data frame analytics to fetch

Query parameters

• allow_no_match boolean

  Whether to ignore if a wildcard expression matches no configs. (This includes _all string or when no configs have been specified)

• bytes string

  The unit in which to display byte values

  Values are b, kb, mb, gb, tb, or pb.

• h string | array[string]

  Comma-separated list of column names to display.

  Supported values include:

  • assignment_explanation (or ae): Contains messages relating to the selection of a node.
  • create_time (or ct, createTime): The time when the data frame analytics job was created.
  • description (or d): A description of a job.
  • dest_index (or di, destIndex): Name of the destination index.
  • failure_reason (or fr, failureReason): Contains messages about the reason why a data frame analytics job failed.
  • id: Identifier for the data frame analytics job.
  • model_memory_limit (or mml, modelMemoryLimit): The approximate maximum amount of memory resources that are permitted for the data frame analytics job.
  • node.address (or na, nodeAddress): The network address of the node that the data frame analytics job is assigned to.
  • node.ephemeral_id (or ne, nodeEphemeralId): The ephemeral ID of the node that the data frame analytics job is assigned to.
  • node.id (or ni, nodeId): The unique identifier of the node that the data frame analytics job is assigned to.
  • node.name (or nn, nodeName): The name of the node that the data frame analytics job is assigned to.
  • progress (or p): The progress report of the data frame analytics job by phase.
  • source_index (or si, sourceIndex): Name of the source index.
  • state (or s): Current state of the data frame analytics job.
  • type (or t): The type of analysis that the data frame analytics job performs.
  • version (or v): The Elasticsearch version number in which the data frame analytics job was created.
• s string | array[string]

  Comma-separated list of column names or column aliases used to sort the response.

  Supported values include:

  • assignment_explanation (or ae): Contains messages relating to the selection of a node.
  • create_time (or ct, createTime): The time when the data frame analytics job was created.
  • description (or d): A description of a job.
  • dest_index (or di, destIndex): Name of the destination index.
  • failure_reason (or fr, failureReason): Contains messages about the reason why a data frame analytics job failed.
  • id: Identifier for the data frame analytics job.
  • model_memory_limit (or mml, modelMemoryLimit): The approximate maximum amount of memory resources that are permitted for the data frame analytics job.
  • node.address (or na, nodeAddress): The network address of the node that the data frame analytics job is assigned to.
  • node.ephemeral_id (or ne, nodeEphemeralId): The ephemeral ID of the node that the data frame analytics job is assigned to.
  • node.id (or ni, nodeId): The unique identifier of the node that the data frame analytics job is assigned to.
  • node.name (or nn, nodeName): The name of the node that the data frame analytics job is assigned to.
  • progress (or p): The progress report of the data frame analytics job by phase.
  • source_index (or si, sourceIndex): Name of the source index.
  • state (or s): Current state of the data frame analytics job.
  • type (or t): The type of analysis that the data frame analytics job performs.
  • version (or v): The Elasticsearch version number in which the data frame analytics job was created.
• time string

  Unit used to display time values.

  Values are nanos, micros, ms, s, m, h, or d.

Responses

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

  • id string
  • type string

    The type of analysis that the job performs.

  • create_time string

    The time when the job was created.

  • version string
  • source_index string
  • dest_index string
  • description string

    A description of the job.

  • model_memory_limit string

    The approximate maximum amount of memory resources that are permitted for the job.

  • state string

    The current status of the job.

  • failure_reason string

    Messages about the reason why the job failed.

  • progress string

    The progress report for the job by phase.

  • assignment_explanation string

    Messages related to the selection of a node.

  • node.id string
  • node.name string
  • node.ephemeral_id string
  • node.address string

    The network address of the assigned node.

Path parameters

• name string Required

  The name of the template to return. Accepts wildcard expressions. If omitted, all templates are returned.

Query parameters

• h string | array[string]

  List of columns to appear in the response. Supports simple wildcards.

• s string | array[string]

  List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

• local boolean

  If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.

• master_timeout string

  Period to wait for a connection to the master node.

Responses

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

  • name string
  • index_patterns string

    The template index patterns.

  • order string

    The template application order or priority number.

  • version string | null

    The template version.

    One of:

    VersionString string string-2 string | null
  • composed_of string

    The component templates that comprise the index template.

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.

• master_timeout string

  Period to wait for a connection to the master node.

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:

      DateTime string 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

Path parameters

• node_id string | array[string] Required

  Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster.

Query parameters

• include_remotes boolean

  Include remote cluster data into the response

• timeout string

  Period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its stats. However, timed out nodes are included in the response’s _nodes.failed property. Defaults to no timeout.

Responses

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

  • _nodes object
    Hide _nodes attributes Show _nodes attributes object

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

      • type string Required

        The type of error

      • reason string

        A human-readable explanation of the error, in English.

      • stack_trace string

        The server stack trace. Present only if the error_trace=true parameter was sent with the request.

      • caused_by object
      • root_cause array[object]
      • suppressed array[object]
    • total number Required

      Total number of nodes selected by the request.

    • successful number Required

      Number of nodes that responded successfully to the request.

    • failed number Required

      Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the rejection or failure is included in the response.

  • cluster_name string Required
  • cluster_uuid string Required
  • indices object Required
    Hide indices attributes Show indices attributes object

    • analysis object Required
      Hide analysis attributes Show analysis attributes object

      • analyzer_types array[object] Required

        Contains statistics about analyzer types used in selected nodes.

        Hide analyzer_types attributes Show analyzer_types attributes object

        • name string Required
        • count number Required

          The number of occurrences of the field type in selected nodes.

        • index_count number Required

          The number of indices containing the field type in selected nodes.

        • indexed_vector_count number

          For dense_vector field types, number of indexed vector types in selected nodes.

        • indexed_vector_dim_max number

          For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.

        • indexed_vector_dim_min number

          For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.

        • script_count number

          The number of fields that declare a script.

      • built_in_analyzers array[object] Required

        Contains statistics about built-in analyzers used in selected nodes.

        Hide built_in_analyzers attributes Show built_in_analyzers attributes object

        • name string Required
        • count number Required

          The number of occurrences of the field type in selected nodes.

        • index_count number Required

          The number of indices containing the field type in selected nodes.

        • indexed_vector_count number

          For dense_vector field types, number of indexed vector types in selected nodes.

        • indexed_vector_dim_max number

          For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.

        • indexed_vector_dim_min number

          For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.

        • script_count number

          The number of fields that declare a script.

      • built_in_char_filters array[object] Required

        Contains statistics about built-in character filters used in selected nodes.

        Hide built_in_char_filters attributes Show built_in_char_filters attributes object

        • name string Required
        • count number Required

          The number of occurrences of the field type in selected nodes.

        • index_count number Required

          The number of indices containing the field type in selected nodes.

        • indexed_vector_count number

          For dense_vector field types, number of indexed vector types in selected nodes.

        • indexed_vector_dim_max number

          For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.

        • indexed_vector_dim_min number

          For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.

        • script_count number

          The number of fields that declare a script.

      • built_in_filters array[object] Required

        Contains statistics about built-in token filters used in selected nodes.

        Hide built_in_filters attributes Show built_in_filters attributes object

        • name string Required
        • count number Required

          The number of occurrences of the field type in selected nodes.

        • index_count number Required

          The number of indices containing the field type in selected nodes.

        • indexed_vector_count number

          For dense_vector field types, number of indexed vector types in selected nodes.

        • indexed_vector_dim_max number

          For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.

        • indexed_vector_dim_min number

          For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.

        • script_count number

          The number of fields that declare a script.

      • built_in_tokenizers array[object] Required

        Contains statistics about built-in tokenizers used in selected nodes.

        Hide built_in_tokenizers attributes Show built_in_tokenizers attributes object

        • name string Required
        • count number Required

          The number of occurrences of the field type in selected nodes.

        • index_count number Required

          The number of indices containing the field type in selected nodes.

        • indexed_vector_count number

          For dense_vector field types, number of indexed vector types in selected nodes.

        • indexed_vector_dim_max number

          For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.

        • indexed_vector_dim_min number

          For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.

        • script_count number

          The number of fields that declare a script.

      • char_filter_types array[object] Required

        Contains statistics about character filter types used in selected nodes.

        Hide char_filter_types attributes Show char_filter_types attributes object

        • name string Required
        • count number Required

          The number of occurrences of the field type in selected nodes.

        • index_count number Required

          The number of indices containing the field type in selected nodes.

        • indexed_vector_count number

          For dense_vector field types, number of indexed vector types in selected nodes.

        • indexed_vector_dim_max number

          For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.

        • indexed_vector_dim_min number

          For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.

        • script_count number

          The number of fields that declare a script.

      • filter_types array[object] Required

        Contains statistics about token filter types used in selected nodes.

        Hide filter_types attributes Show filter_types attributes object

        • name string Required
        • count number Required

          The number of occurrences of the field type in selected nodes.

        • index_count number Required

          The number of indices containing the field type in selected nodes.

        • indexed_vector_count number

          For dense_vector field types, number of indexed vector types in selected nodes.

        • indexed_vector_dim_max number

          For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.

        • indexed_vector_dim_min number

          For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.

        • script_count number

          The number of fields that declare a script.

      • tokenizer_types array[object] Required

        Contains statistics about tokenizer types used in selected nodes.

        Hide tokenizer_types attributes Show tokenizer_types attributes object

        • name string Required
        • count number Required

          The number of occurrences of the field type in selected nodes.

        • index_count number Required

          The number of indices containing the field type in selected nodes.

        • indexed_vector_count number

          For dense_vector field types, number of indexed vector types in selected nodes.

        • indexed_vector_dim_max number

          For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.

        • indexed_vector_dim_min number

          For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.

        • script_count number

          The number of fields that declare a script.

    • completion object Required
      Hide completion attributes Show completion attributes object

      • size_in_bytes number Required

        Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes.

      • size number | string

        One of:

        ByteSize number ByteSize string
      • fields object
        Hide fields attribute Show fields attribute object

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

          • size
          • size_in_bytes number Required
    • count number Required

      Total number of indices with shards assigned to selected nodes.

    • docs object Required
      Hide docs attributes Show docs attributes object

      • count number Required

        Total number of non-deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments and may include documents from nested fields.

      • deleted number

        Total number of deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments. Elasticsearch reclaims the disk space of deleted Lucene documents when a segment is merged.

    • fielddata object Required
      Hide fielddata attributes Show fielddata attributes object

      • evictions number

      • memory_size number | string

        One of:

        ByteSize number ByteSize string
      • memory_size_in_bytes number Required
      • fields object
        Hide fields attribute Show fields attribute object

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

          • memory_size
          • memory_size_in_bytes number Required
    • query_cache object Required
      Hide query_cache attributes Show query_cache attributes object

      • cache_count number Required

        Total number of entries added to the query cache across all shards assigned to selected nodes. This number includes current and evicted entries.

      • cache_size number Required

        Total number of entries currently in the query cache across all shards assigned to selected nodes.

      • evictions number Required

        Total number of query cache evictions across all shards assigned to selected nodes.

      • hit_count number Required

        Total count of query cache hits across all shards assigned to selected nodes.

      • memory_size number | string

        One of:

        ByteSize number ByteSize string
      • memory_size_in_bytes number Required

        Total amount, in bytes, of memory used for the query cache across all shards assigned to selected nodes.

      • miss_count number Required

        Total count of query cache misses across all shards assigned to selected nodes.

      • total_count number Required

        Total count of hits and misses in the query cache across all shards assigned to selected nodes.

    • segments object Required
      Hide segments attributes Show segments attributes object

      • count number Required

        Total number of segments across all shards assigned to selected nodes.

      • doc_values_memory number | string

        One of:

        ByteSize number ByteSize string
      • doc_values_memory_in_bytes number Required

        Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes.

      • file_sizes object Required

        This object is not populated by the cluster stats API. To get information on segment files, use the node stats API.

        Hide file_sizes attribute Show file_sizes attribute object

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

          • description string Required
          • size_in_bytes number Required
          • min_size_in_bytes number
          • max_size_in_bytes number
          • average_size_in_bytes number
          • count number

      • fixed_bit_set number | string

        One of:

        ByteSize number ByteSize string
      • fixed_bit_set_memory_in_bytes number Required

        Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes.

      • index_writer_memory number | string

        One of:

        ByteSize number ByteSize string
      • index_writer_max_memory_in_bytes number
      • index_writer_memory_in_bytes number Required

        Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes.

      • max_unsafe_auto_id_timestamp number Required

        Unix timestamp, in milliseconds, of the most recently retried indexing request.

      • memory number | string

        One of:

        ByteSize number ByteSize string
      • memory_in_bytes number Required

        Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes.

      • norms_memory number | string

        One of:

        ByteSize number ByteSize string
      • norms_memory_in_bytes number Required

        Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes.

      • points_memory number | string

        One of:

        ByteSize number ByteSize string
      • points_memory_in_bytes number Required

        Total amount, in bytes, of memory used for points across all shards assigned to selected nodes.

      • stored_memory number | string

        One of:

        ByteSize number ByteSize string
      • stored_fields_memory_in_bytes number Required

        Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes.

      • terms_memory_in_bytes number Required

        Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes.

      • terms_memory number | string

        One of:

        ByteSize number ByteSize string

      • term_vectory_memory number | string

        One of:

        ByteSize number ByteSize string
      • term_vectors_memory_in_bytes number Required

        Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes.

      • version_map_memory number | string

        One of:

        ByteSize number ByteSize string
      • version_map_memory_in_bytes number Required

        Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes.

    • shards object Required
      Hide shards attributes Show shards attributes object

      • index object
        Hide index attributes Show index attributes object

        • primaries object Required
          Hide primaries attributes Show primaries attributes object

          • avg number Required

            Mean number of shards in an index, counting only shards assigned to selected nodes.

          • max number Required

            Maximum number of shards in an index, counting only shards assigned to selected nodes.

          • min number Required

            Minimum number of shards in an index, counting only shards assigned to selected nodes.

        • replication object Required
          Hide replication attributes Show replication attributes object

          • avg number Required

            Mean number of shards in an index, counting only shards assigned to selected nodes.

          • max number Required

            Maximum number of shards in an index, counting only shards assigned to selected nodes.

          • min number Required

            Minimum number of shards in an index, counting only shards assigned to selected nodes.

        • shards object Required
          Hide shards attributes Show shards attributes object

          • avg number Required

            Mean number of shards in an index, counting only shards assigned to selected nodes.

          • max number Required

            Maximum number of shards in an index, counting only shards assigned to selected nodes.

          • min number Required

            Minimum number of shards in an index, counting only shards assigned to selected nodes.

      • primaries number

        Number of primary shards assigned to selected nodes.

      • replication number

        Ratio of replica shards to primary shards across all selected nodes.

      • total number

        Total number of shards assigned to selected nodes.

    • store object Required
      Hide store attributes Show store attributes object

      • size number | string

        One of:

        ByteSize number ByteSize string
      • size_in_bytes number Required

        Total size, in bytes, of all shards assigned to selected nodes.

      • reserved number | string

        One of:

        ByteSize number ByteSize string
      • reserved_in_bytes number Required

        A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities.

      • total_data_set_size number | string

        One of:

        ByteSize number ByteSize string
      • total_data_set_size_in_bytes number

        Total data set size, in bytes, of all shards assigned to selected nodes. This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices.

    • mappings object Required
      Hide mappings attributes Show mappings attributes object

      • field_types array[object] Required

        Contains statistics about field data types used in selected nodes.

        Hide field_types attributes Show field_types attributes object

        • name string Required
        • count number Required

          The number of occurrences of the field type in selected nodes.

        • index_count number Required

          The number of indices containing the field type in selected nodes.

        • indexed_vector_count number

          For dense_vector field types, number of indexed vector types in selected nodes.

        • indexed_vector_dim_max number

          For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.

        • indexed_vector_dim_min number

          For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.

        • script_count number

          The number of fields that declare a script.

      • runtime_field_types array[object]

        Contains statistics about runtime field data types used in selected nodes.

        Hide runtime_field_types attributes Show runtime_field_types attributes object

        • chars_max number Required

          Maximum number of characters for a single runtime field script.

        • chars_total number Required

          Total number of characters for the scripts that define the current runtime field data type.

        • count number Required

          Number of runtime fields mapped to the field data type in selected nodes.

        • doc_max number Required

          Maximum number of accesses to doc_values for a single runtime field script

        • doc_total number Required

          Total number of accesses to doc_values for the scripts that define the current runtime field data type.

        • index_count number Required

          Number of indices containing a mapping of the runtime field data type in selected nodes.

        • lang array[string] Required

          Script languages used for the runtime fields scripts.

        • lines_max number Required

          Maximum number of lines for a single runtime field script.

        • lines_total number Required

          Total number of lines for the scripts that define the current runtime field data type.

        • name string Required
        • scriptless_count number Required

          Number of runtime fields that don’t declare a script.

        • shadowed_count number Required

          Number of runtime fields that shadow an indexed field.

        • source_max number Required

          Maximum number of accesses to _source for a single runtime field script.

        • source_total number Required

          Total number of accesses to _source for the scripts that define the current runtime field data type.

      • total_field_count number

        Total number of fields in all non-system indices.

      • total_deduplicated_field_count number

        Total number of fields in all non-system indices, accounting for mapping deduplication.

      • total_deduplicated_mapping_size number | string

        One of:

        ByteSize number ByteSize string
      • total_deduplicated_mapping_size_in_bytes number

        Total size of all mappings, in bytes, after deduplication and compression.

    • versions array[object]

      Contains statistics about analyzers and analyzer components used in selected nodes.

      Hide versions attributes Show versions attributes object

      • index_count number Required
      • primary_shard_count number Required
      • total_primary_bytes number Required
      • version string Required
  • nodes object Required
    Hide nodes attributes Show nodes attributes object

    • count object Required
      Hide count attributes Show count attributes object

      • coordinating_only number Required
      • data number Required
      • data_cold number Required
      • data_content number Required
      • data_frozen number
      • data_hot number Required
      • data_warm number Required
      • ingest number Required
      • master number Required
      • ml number Required
      • remote_cluster_client number Required
      • total number Required
      • transform number Required
      • voting_only number Required
    • discovery_types object Required

      Contains statistics about the discovery types used by selected nodes.

      Hide discovery_types attribute Show discovery_types attribute object

      • * number Additional properties
    • fs object Required
      Hide fs attributes Show fs attributes object

      • available_in_bytes number Required

        Total number of bytes available to JVM in file stores across all selected nodes. Depending on operating system or process-level restrictions, this number may be less than nodes.fs.free_in_byes. This is the actual amount of free disk space the selected Elasticsearch nodes can use.

      • free_in_bytes number Required

        Total number of unallocated bytes in file stores across all selected nodes.

      • total_in_bytes number Required

        Total size, in bytes, of all file stores across all selected nodes.

    • indexing_pressure object Required
      Hide indexing_pressure attribute Show indexing_pressure attribute object

      • memory object Required
        Hide memory attributes Show memory attributes object

        • current object Required
          Hide current attributes Show current attributes object

          • all_in_bytes number Required
          • combined_coordinating_and_primary_in_bytes number Required
          • coordinating_in_bytes number Required
          • coordinating_rejections number
          • primary_in_bytes number Required
          • primary_rejections number
          • replica_in_bytes number Required
          • replica_rejections number
        • limit_in_bytes number Required
        • total object Required
          Hide total attributes Show total attributes object

          • all_in_bytes number Required
          • combined_coordinating_and_primary_in_bytes number Required
          • coordinating_in_bytes number Required
          • coordinating_rejections number
          • primary_in_bytes number Required
          • primary_rejections number
          • replica_in_bytes number Required
          • replica_rejections number
    • ingest object Required
      Hide ingest attributes Show ingest attributes object

      • number_of_pipelines number Required
      • processor_stats object Required
        Hide processor_stats attribute Show processor_stats attribute object

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

          • count number Required
          • current number Required
          • failed number Required
          • time 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.

    • jvm object Required
      Hide jvm attributes Show jvm attributes object

      • Time unit for milliseconds

      • mem object Required
        Hide mem attributes Show mem attributes object

        • heap_max_in_bytes number Required

          Maximum amount of memory, in bytes, available for use by the heap across all selected nodes.

        • heap_used_in_bytes number Required

          Memory, in bytes, currently in use by the heap across all selected nodes.

      • threads number Required

        Number of active threads in use by JVM across all selected nodes.

      • versions array[object] Required

        Contains statistics about the JVM versions used by selected nodes.

        Hide versions attributes Show versions attributes object

        • bundled_jdk boolean Required

          Always true. All distributions come with a bundled Java Development Kit (JDK).

        • count number Required

          Total number of selected nodes using JVM.

        • using_bundled_jdk boolean Required

          If true, a bundled JDK is in use by JVM.

        • version string Required
        • vm_name string Required

          Name of the JVM.

        • vm_vendor string Required

          Vendor of the JVM.

        • vm_version string Required
    • network_types object Required
      Hide network_types attributes Show network_types attributes object

      • http_types object Required

        Contains statistics about the HTTP network types used by selected nodes.

        Hide http_types attribute Show http_types attribute object

        • * number Additional properties
      • transport_types object Required

        Contains statistics about the transport network types used by selected nodes.

        Hide transport_types attribute Show transport_types attribute object

        • * number Additional properties
    • os object Required
      Hide os attributes Show os attributes object

      • allocated_processors number Required

        Number of processors used to calculate thread pool size across all selected nodes. This number can be set with the processors setting of a node and defaults to the number of processors reported by the operating system. In both cases, this number will never be larger than 32.

      • architectures array[object]

        Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes.

        Hide architectures attributes Show architectures attributes object

        • arch string Required

          Name of an architecture used by one or more selected nodes.

        • count number Required

          Number of selected nodes using the architecture.

      • available_processors number Required

        Number of processors available to JVM across all selected nodes.

      • mem object Required
        Hide mem attributes Show mem attributes object

        • adjusted_total_in_bytes number

          Total amount, in bytes, of memory across all selected nodes, but using the value specified using the es.total_memory_bytes system property instead of measured total memory for those nodes where that system property was set.

        • free_in_bytes number Required

          Amount, in bytes, of free physical memory across all selected nodes.

        • free_percent number Required

          Percentage of free physical memory across all selected nodes.

        • total_in_bytes number Required

          Total amount, in bytes, of physical memory across all selected nodes.

        • used_in_bytes number Required

          Amount, in bytes, of physical memory in use across all selected nodes.

        • used_percent number Required

          Percentage of physical memory in use across all selected nodes.

      • names array[object] Required

        Contains statistics about operating systems used by selected nodes.

        Hide names attributes Show names attributes object

        • count number Required

          Number of selected nodes using the operating system.

        • name string Required
      • pretty_names array[object] Required

        Contains statistics about operating systems used by selected nodes.

        Hide pretty_names attributes Show pretty_names attributes object

        • count number Required

          Number of selected nodes using the operating system.

        • pretty_name string Required
    • packaging_types array[object] Required

      Contains statistics about Elasticsearch distributions installed on selected nodes.

      Hide packaging_types attributes Show packaging_types attributes object

      • count number Required

        Number of selected nodes using the distribution flavor and file type.

      • flavor string Required

        Type of Elasticsearch distribution. This is always default.

      • type string Required

        File type (such as tar or zip) used for the distribution package.

    • plugins array[object] Required

      Contains statistics about installed plugins and modules by selected nodes. If no plugins or modules are installed, this array is empty.

      Hide plugins attributes Show plugins attributes object

      • classname string Required
      • description string Required
      • elasticsearch_version string Required
      • extended_plugins array[string] Required
      • has_native_controller boolean Required
      • java_version string Required
      • name string Required
      • version string Required
      • licensed boolean Required
    • process object Required
      Hide process attributes Show process attributes object

      • cpu object Required
        Hide cpu attribute Show cpu attribute object

        • percent number Required

          Percentage of CPU used across all selected nodes. Returns -1 if not supported.

      • open_file_descriptors object Required
        Hide open_file_descriptors attributes Show open_file_descriptors attributes object

        • avg number Required

          Average number of concurrently open file descriptors. Returns -1 if not supported.

        • max number Required

          Maximum number of concurrently open file descriptors allowed across all selected nodes. Returns -1 if not supported.

        • min number Required

          Minimum number of concurrently open file descriptors across all selected nodes. Returns -1 if not supported.

    • versions array[string] Required

      Array of Elasticsearch versions used on selected nodes.

  • status string Required

    Values are green, GREEN, yellow, YELLOW, red, or RED.

  • timestamp number Required

    Unix timestamp, in milliseconds, for the last time the cluster statistics were refreshed.

  • ccs object Required
    Hide ccs attributes Show ccs attributes object

    • clusters object

      Contains remote cluster settings and metrics collected from them. The keys are cluster names, and the values are per-cluster data. Only present if include_remotes option is set to true.

      Hide clusters attribute Show clusters attribute object

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

        • cluster_uuid string Required

          The UUID of the remote cluster.

        • mode string Required

          The connection mode used to communicate with the remote cluster.

        • skip_unavailable boolean Required

          The skip_unavailable setting used for this remote cluster.

        • transport_compress string Required

          Transport compression setting used for this remote cluster.

        • status string Required

          Values are green, GREEN, yellow, YELLOW, red, or RED.

        • version array[string] Required

          The list of Elasticsearch versions used by the nodes on the remote cluster.

        • nodes_count number Required

          The total count of nodes in the remote cluster.

        • shards_count number Required

          The total number of shards in the remote cluster.

        • indices_count number Required

          The total number of indices in the remote cluster.

        • indices_total_size_in_bytes number Required

          Total data set size, in bytes, of all shards assigned to selected nodes.

        • indices_total_size string

          Total data set size of all shards assigned to selected nodes, as a human-readable string.

        • max_heap_in_bytes number Required

          Maximum amount of memory, in bytes, available for use by the heap across the nodes of the remote cluster.

        • max_heap string

          Maximum amount of memory available for use by the heap across the nodes of the remote cluster, as a human-readable string.

        • mem_total_in_bytes number Required

          Total amount, in bytes, of physical memory across the nodes of the remote cluster.

        • mem_total string

          Total amount of physical memory across the nodes of the remote cluster, as a human-readable string.

    • _search object Required
      Hide _search attributes Show _search attributes object

      • total number Required

        The total number of cross-cluster search requests that have been executed by the cluster.

      • success number Required

        The total number of cross-cluster search requests that have been successfully executed by the cluster.

      • skipped number Required

        The total number of cross-cluster search requests (successful or failed) that had at least one remote cluster skipped.

      • took object Required
        Hide took attributes Show took attributes object

        • Time unit for milliseconds

        • Time unit for milliseconds

        • Time unit for milliseconds

      • took_mrt_true object
        Hide took_mrt_true attributes Show took_mrt_true attributes object

        • Time unit for milliseconds

        • Time unit for milliseconds

        • Time unit for milliseconds

      • took_mrt_false object
        Hide took_mrt_false attributes Show took_mrt_false attributes object

        • Time unit for milliseconds

        • Time unit for milliseconds

        • Time unit for milliseconds

      • remotes_per_search_max number Required

        The maximum number of remote clusters that were queried in a single cross-cluster search request.

      • remotes_per_search_avg number Required

        The average number of remote clusters that were queried in a single cross-cluster search request.

      • failure_reasons object Required

        Statistics about the reasons for cross-cluster search request failures. The keys are the failure reason names and the values are the number of requests that failed for that reason.

        Hide failure_reasons attribute Show failure_reasons attribute object

        • * number Additional properties
      • features object Required

        The keys are the names of the search feature, and the values are the number of requests that used that feature. Single request can use more than one feature (e.g. both async and wildcard).

        Hide features attribute Show features attribute object

        • * number Additional properties
      • clients object Required

        Statistics about the clients that executed cross-cluster search requests. The keys are the names of the clients, and the values are the number of requests that were executed by that client. Only known clients (such as kibana or elasticsearch) are counted.

        Hide clients attribute Show clients attribute object

        • * number Additional properties
      • clusters object Required

        Statistics about the clusters that were queried in cross-cluster search requests. The keys are cluster names, and the values are per-cluster telemetry data. This also includes the local cluster itself, which uses the name (local).

        Hide clusters attribute Show clusters attribute object

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

          • total number Required

            The total number of successful (not skipped) cross-cluster search requests that were executed against this cluster. This may include requests where partial results were returned, but not requests in which the cluster has been skipped entirely.

          • skipped number Required

            The total number of cross-cluster search requests for which this cluster was skipped.

          • took object Required
    • _esql object
      Hide _esql attributes Show _esql attributes object

      • total number Required

        The total number of cross-cluster search requests that have been executed by the cluster.

      • success number Required

        The total number of cross-cluster search requests that have been successfully executed by the cluster.

      • skipped number Required

        The total number of cross-cluster search requests (successful or failed) that had at least one remote cluster skipped.

      • took object Required
        Hide took attributes Show took attributes object

        • Time unit for milliseconds

        • Time unit for milliseconds

        • Time unit for milliseconds

      • took_mrt_true object
        Hide took_mrt_true attributes Show took_mrt_true attributes object

        • Time unit for milliseconds

        • Time unit for milliseconds

        • Time unit for milliseconds

      • took_mrt_false object
        Hide took_mrt_false attributes Show took_mrt_false attributes object

        • Time unit for milliseconds

        • Time unit for milliseconds

        • Time unit for milliseconds

      • remotes_per_search_max number Required

        The maximum number of remote clusters that were queried in a single cross-cluster search request.

      • remotes_per_search_avg number Required

        The average number of remote clusters that were queried in a single cross-cluster search request.

      • failure_reasons object Required

        Statistics about the reasons for cross-cluster search request failures. The keys are the failure reason names and the values are the number of requests that failed for that reason.

        Hide failure_reasons attribute Show failure_reasons attribute object

        • * number Additional properties
      • features object Required

        The keys are the names of the search feature, and the values are the number of requests that used that feature. Single request can use more than one feature (e.g. both async and wildcard).

        Hide features attribute Show features attribute object

        • * number Additional properties
      • clients object Required

        Statistics about the clients that executed cross-cluster search requests. The keys are the names of the clients, and the values are the number of requests that were executed by that client. Only known clients (such as kibana or elasticsearch) are counted.

        Hide clients attribute Show clients attribute object

        • * number Additional properties
      • clusters object Required

        Statistics about the clusters that were queried in cross-cluster search requests. The keys are cluster names, and the values are per-cluster telemetry data. This also includes the local cluster itself, which uses the name (local).

        Hide clusters attribute Show clusters attribute object

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

          • total number Required

            The total number of successful (not skipped) cross-cluster search requests that were executed against this cluster. This may include requests where partial results were returned, but not requests in which the cluster has been skipped entirely.

          • skipped number Required

            The total number of cross-cluster search requests for which this cluster was skipped.

          • took object Required