Path parameters

• name string Required

  the name of the autoscaling policy

Query parameters

• master_timeout string

  Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

• timeout string

  Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

Responses

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

  • acknowledged boolean Required

    For a successful response, this value is always true. On failure, an exception is returned instead.

Path parameters

• name string Required

  The name of the analytics collection to be created or updated.

Responses

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

  • acknowledged boolean Required

    For a successful response, this value is always true. On failure, an exception is returned instead.

  • name string Required

Path parameters

• name string Required

  The name of the analytics collection to be deleted

Responses

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

  • acknowledged boolean Required

    For a successful response, this value is always true. On failure, an exception is returned instead.

Path parameters

• collection_name string Required

  The name of the behavioral analytics collection.

• event_type string Required

  The analytics event type.

  Values are page_view, search, or search_click.

Query parameters

• debug boolean

  Whether the response type has to include more details

Responses

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

  • accepted boolean Required
  • event object

    Additional properties are allowed.

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.

• expand_wildcards string | array[string]

  The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as open,hidden.

• master_timeout string

  The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicated that the request should never timeout, you can set it to -1.

Responses

• 200

  application/json

  application/json text/plain
  Hide response attributes Show response attributes object

  • alias string

    alias name

  • index string
  • filter string

    filter

  • routing.index string

    index routing

  • routing.search string

    search routing

  • is_write_index string

    write index

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

  The period to wait for a connection to the master node.

Responses

• 200

  application/json

  application/json text/plain
  Hide response attributes Show response attributes object

  • name string Required

  • version string | null Required

    One of:

    string-1 string string-2 string | null
  • alias_count string Required
  • mapping_count string Required
  • settings_count string Required
  • metadata_count string Required
  • included_in string Required

Query parameters

• bytes string

  The unit used to display byte values.

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

• fields string | array[string]

  Comma-separated list of fields used to limit returned information.

• 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.

Responses

• 200

  application/json

  application/json text/plain
  Hide response attributes Show response attributes object

  • id string

    node id

  • host string

    host name

  • ip string

    ip address

  • node string

    node name

  • field string

    field name

  • size string

    field data usage

Path parameters

• fields string | array[string] Required

  Comma-separated list of fields used to limit returned information. To retrieve all fields, omit this parameter.

Query parameters

• bytes string

  The unit used to display byte values.

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

• fields string | array[string]

  Comma-separated list of fields used to limit returned information.

• 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.

Responses

• 200

  application/json

  application/json text/plain
  Hide response attributes Show response attributes object

  • id string

    node id

  • host string

    host name

  • ip string

    ip address

  • node string

    node name

  • field string

    field name

  • size string

    field data usage

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

  application/json text/plain
  Hide response attributes Show response attributes object

  • id string

    node id

  • host string

    host name

  • ip string

    ip address

  • node string

    node name

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.

• s string | array[string]

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

• time string

  Unit used to display time values.

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

Responses

• 200

  application/json

  application/json text/plain
  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

• job_id string Required

  Identifier for the anomaly detection job.

Query parameters

• allow_no_match boolean

  Specifies what to do when the request:

  • Contains wildcard expressions and there are no jobs that match.
  • Contains the _all string or no identifiers and there are no matches.
  • Contains wildcard expressions and there are only partial matches.

  If true, the API returns an empty jobs array when there are no matches and the subset of results when there are partial matches. If false, the API returns a 404 status code when there are no matches or only partial matches.

• bytes string

  The unit used 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.

• s string | array[string]

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

• time string

  The unit used to display time values.

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

Responses

• 200

  application/json

  application/json text/plain
  Hide response attributes Show response attributes object

  • id string
  • state string

    Values are closing, closed, opened, failed, or opening.

  • opened_time string

    For open jobs only, the amount of time the job has been opened.

  • assignment_explanation string

    For open anomaly detection jobs only, contains messages relating to the selection of a node to run the job.

  • data.processed_records string

    The number of input documents that have been processed by the anomaly detection job. This value includes documents with missing fields, since they are nonetheless analyzed. If you use datafeeds and have aggregations in your search query, the processed_record_count is the number of aggregation results processed, not the number of Elasticsearch documents.

  • data.processed_fields string

    The total number of fields in all the documents that have been processed by the anomaly detection job. Only fields that are specified in the detector configuration object contribute to this count. The timestamp is not included in this count.

  • data.input_bytes number | string

    One of:

    _types:ByteSize number _types:ByteSize string
  • data.input_records string

    The number of input documents posted to the anomaly detection job.

  • data.input_fields string

    The total number of fields in input documents posted to the anomaly detection job. This count includes fields that are not used in the analysis. However, be aware that if you are using a datafeed, it extracts only the required fields from the documents it retrieves before posting them to the job.

  • data.invalid_dates string

    The number of input documents with either a missing date field or a date that could not be parsed.

  • data.missing_fields string

    The number of input documents that are missing a field that the anomaly detection job is configured to analyze. Input documents with missing fields are still processed because it is possible that not all fields are missing. If you are using datafeeds or posting data to the job in JSON format, a high missing_field_count is often not an indication of data issues. It is not necessarily a cause for concern.

  • data.out_of_order_timestamps string

    The number of input documents that have a timestamp chronologically preceding the start of the current anomaly detection bucket offset by the latency window. This information is applicable only when you provide data to the anomaly detection job by using the post data API. These out of order documents are discarded, since jobs require time series data to be in ascending chronological order.

  • data.empty_buckets string

    The number of buckets which did not contain any data. If your data contains many empty buckets, consider increasing your bucket_span or using functions that are tolerant to gaps in data such as mean, non_null_sum or non_zero_count.

  • data.sparse_buckets string

    The number of buckets that contained few data points compared to the expected number of data points. If your data contains many sparse buckets, consider using a longer bucket_span.

  • data.buckets string

    The total number of buckets processed.

  • data.earliest_record string

    The timestamp of the earliest chronologically input document.

  • data.latest_record string

    The timestamp of the latest chronologically input document.

  • data.last string

    The timestamp at which data was last analyzed, according to server time.

  • data.last_empty_bucket string

    The timestamp of the last bucket that did not contain any data.

  • data.last_sparse_bucket string

    The timestamp of the last bucket that was considered sparse.

  • model.bytes number | string

    One of:

    _types:ByteSize number _types:ByteSize string
  • model.memory_status string

    Values are ok, soft_limit, or hard_limit.

  • model.bytes_exceeded number | string

    One of:

    _types:ByteSize number _types:ByteSize string
  • model.memory_limit string

    The upper limit for model memory usage, checked on increasing values.

  • model.by_fields string

    The number of by field values that were analyzed by the models. This value is cumulative for all detectors in the job.

  • model.over_fields string

    The number of over field values that were analyzed by the models. This value is cumulative for all detectors in the job.

  • model.partition_fields string

    The number of partition field values that were analyzed by the models. This value is cumulative for all detectors in the job.

  • model.bucket_allocation_failures string

    The number of buckets for which new entities in incoming data were not processed due to insufficient model memory. This situation is also signified by a hard_limit: memory_status property value.

  • model.categorization_status string

    Values are ok or warn.

  • model.categorized_doc_count string

    The number of documents that have had a field categorized.

  • model.total_category_count string

    The number of categories created by categorization.

  • model.frequent_category_count string

    The number of categories that match more than 1% of categorized documents.

  • model.rare_category_count string

    The number of categories that match just one categorized document.

  • model.dead_category_count string

    The number of categories created by categorization that will never be assigned again because another category’s definition makes it a superset of the dead category. Dead categories are a side effect of the way categorization has no prior training.

  • model.failed_category_count string

    The number of times that categorization wanted to create a new category but couldn’t because the job had hit its model_memory_limit. This count does not track which specific categories failed to be created. Therefore you cannot use this value to determine the number of unique categories that were missed.

  • model.log_time string

    The timestamp when the model stats were gathered, according to server time.

  • model.timestamp string

    The timestamp of the last record when the model stats were gathered.

  • forecasts.total string

    The number of individual forecasts currently available for the job. A value of one or more indicates that forecasts exist.

  • forecasts.memory.min string

    The minimum memory usage in bytes for forecasts related to the anomaly detection job.

  • forecasts.memory.max string

    The maximum memory usage in bytes for forecasts related to the anomaly detection job.

  • forecasts.memory.avg string

    The average memory usage in bytes for forecasts related to the anomaly detection job.

  • forecasts.memory.total string

    The total memory usage in bytes for forecasts related to the anomaly detection job.

  • forecasts.records.min string

    The minimum number of model_forecast documents written for forecasts related to the anomaly detection job.

  • forecasts.records.max string

    The maximum number of model_forecast documents written for forecasts related to the anomaly detection job.

  • forecasts.records.avg string

    The average number of model_forecast documents written for forecasts related to the anomaly detection job.

  • forecasts.records.total string

    The total number of model_forecast documents written for forecasts related to the anomaly detection job.

  • forecasts.time.min string

    The minimum runtime in milliseconds for forecasts related to the anomaly detection job.

  • forecasts.time.max string

    The maximum runtime in milliseconds for forecasts related to the anomaly detection job.

  • forecasts.time.avg string

    The average runtime in milliseconds for forecasts related to the anomaly detection job.

  • forecasts.time.total string

    The total runtime in milliseconds for forecasts related to the anomaly detection job.

  • node.id string
  • node.name string

    The name of the assigned node.

  • node.ephemeral_id string
  • node.address string

    The network address of the assigned node.

  • buckets.count string

    The number of bucket results produced by the job.

  • buckets.time.total string

    The sum of all bucket processing times, in milliseconds.

  • buckets.time.min string

    The minimum of all bucket processing times, in milliseconds.

  • buckets.time.max string

    The maximum of all bucket processing times, in milliseconds.

  • buckets.time.exp_avg string

    The exponential moving average of all bucket processing times, in milliseconds.

  • buckets.time.exp_avg_hour string

    The exponential moving average of bucket processing times calculated in a one hour time window, in milliseconds.

Query parameters

• allow_no_match boolean

  Specifies what to do when the request: contains wildcard expressions and there are no models that match; contains the _all string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. If true, the API returns an empty array when there are no matches and the subset of results when there are partial matches. If false, the API returns a 404 status code when there are no matches or only partial matches.

• bytes string

  The unit used to display byte values.

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

• h string | array[string]

  A comma-separated list of column names to display.

• s string | array[string]

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

• from number

  Skips the specified number of transforms.

• size number

  The maximum number of transforms to display.

• time string

  Unit used to display time values.

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

Responses

• 200

  application/json

  application/json text/plain
  Hide response attributes Show response attributes object

  • id string
  • created_by string

    Information about the creator of the model.

  • heap_size number | string

    One of:

    _types:ByteSize number _types:ByteSize string
  • operations string

    The estimated number of operations to use the model. This number helps to measure the computational complexity of the model.

  • license string

    The license level of the model.

  • create_time string | number

    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

  • version string
  • description string

    A description of the model.

  • ingest.pipelines string

    The number of pipelines that are referencing the model.

  • ingest.count string

    The total number of documents that are processed by the model.

  • ingest.time string

    The total time spent processing documents with thie model.

  • ingest.current string

    The total number of documents that are currently being handled by the model.

  • ingest.failed string

    The total number of failed ingest attempts with the model.

  • data_frame.id string

    The identifier for the data frame analytics job that created the model. Only displayed if the job is still available.

  • data_frame.create_time string

    The time the data frame analytics job was created.

  • data_frame.source_index string

    The source index used to train in the data frame analysis.

  • data_frame.analysis string

    The analysis used by the data frame to build the model.

  • type string

Path parameters

• model_id string Required

  A unique identifier for the trained model.

Query parameters

• allow_no_match boolean

  Specifies what to do when the request: contains wildcard expressions and there are no models that match; contains the _all string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. If true, the API returns an empty array when there are no matches and the subset of results when there are partial matches. If false, the API returns a 404 status code when there are no matches or only partial matches.

• bytes string

  The unit used to display byte values.

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

• h string | array[string]

  A comma-separated list of column names to display.

• s string | array[string]

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

• from number

  Skips the specified number of transforms.

• size number

  The maximum number of transforms to display.

• time string

  Unit used to display time values.

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

Responses

• 200

  application/json

  application/json text/plain
  Hide response attributes Show response attributes object

  • id string
  • created_by string

    Information about the creator of the model.

  • heap_size number | string

    One of:

    _types:ByteSize number _types:ByteSize string
  • operations string

    The estimated number of operations to use the model. This number helps to measure the computational complexity of the model.

  • license string

    The license level of the model.

  • create_time string | number

    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

  • version string
  • description string

    A description of the model.

  • ingest.pipelines string

    The number of pipelines that are referencing the model.

  • ingest.count string

    The total number of documents that are processed by the model.

  • ingest.time string

    The total time spent processing documents with thie model.

  • ingest.current string

    The total number of documents that are currently being handled by the model.

  • ingest.failed string

    The total number of failed ingest attempts with the model.

  • data_frame.id string

    The identifier for the data frame analytics job that created the model. Only displayed if the job is still available.

  • data_frame.create_time string

    The time the data frame analytics job was created.

  • data_frame.source_index string

    The source index used to train in the data frame analysis.

  • data_frame.analysis string

    The analysis used by the data frame to build the model.

  • type string

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

  application/json text/plain
  Hide response attributes Show response attributes object

  • id string

    The unique repository identifier.

  • type string

    The repository type.

Query parameters

• bytes string

  The unit used to display byte values.

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

• 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.

• master_timeout string

  Period to wait for a connection to the master node.

• time string

  Unit used to display time values.

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

Responses

• 200

  application/json

  application/json text/plain
  Hide response attributes Show response attributes object

  • index string

    The index name.

  • shard string

    The shard name.

  • prirep string

    The shard type: primary or replica.

  • state string

    The shard state. Returned values include: INITIALIZING: The shard is recovering from a peer shard or gateway. RELOCATING: The shard is relocating. STARTED: The shard has started. UNASSIGNED: The shard is not assigned to any node.

  • docs string | null

    The number of documents in the shard.

    One of:

    string-1 string string-2 string | null

  • store string | null

    The disk space used by the shard.

    One of:

    string-1 string string-2 string | null

  • dataset string | null

    total size of dataset (including the cache for partially mounted indices)

    One of:

    string-1 string string-2 string | null

  • ip string | null

    The IP address of the node.

    One of:

    string-1 string string-2 string | null
  • id string

    The unique identifier for the node.

  • node string | null

    The name of node.

    One of:

    string-1 string string-2 string | null
  • sync_id string

    The sync identifier.

  • unassigned.reason string

    The reason for the last change to the state of an unassigned shard. It does not explain why the shard is currently unassigned; use the cluster allocation explain API for that information. Returned values include: ALLOCATION_FAILED: Unassigned as a result of a failed allocation of the shard. CLUSTER_RECOVERED: Unassigned as a result of a full cluster recovery. DANGLING_INDEX_IMPORTED: Unassigned as a result of importing a dangling index. EXISTING_INDEX_RESTORED: Unassigned as a result of restoring into a closed index. FORCED_EMPTY_PRIMARY: The shard’s allocation was last modified by forcing an empty primary using the cluster reroute API. INDEX_CLOSED: Unassigned because the index was closed. INDEX_CREATED: Unassigned as a result of an API creation of an index. INDEX_REOPENED: Unassigned as a result of opening a closed index. MANUAL_ALLOCATION: The shard’s allocation was last modified by the cluster reroute API. NEW_INDEX_RESTORED: Unassigned as a result of restoring into a new index. NODE_LEFT: Unassigned as a result of the node hosting it leaving the cluster. NODE_RESTARTING: Similar to NODE_LEFT, except that the node was registered as restarting using the node shutdown API. PRIMARY_FAILED: The shard was initializing as a replica, but the primary shard failed before the initialization completed. REALLOCATED_REPLICA: A better replica location is identified and causes the existing replica allocation to be cancelled. REINITIALIZED: When a shard moves from started back to initializing. REPLICA_ADDED: Unassigned as a result of explicit addition of a replica. REROUTE_CANCELLED: Unassigned as a result of explicit cancel reroute command.

  • unassigned.at string

    The time at which the shard became unassigned in Coordinated Universal Time (UTC).

  • unassigned.for string

    The time at which the shard was requested to be unassigned in Coordinated Universal Time (UTC).

  • unassigned.details string

    Additional details as to why the shard became unassigned. It does not explain why the shard is not assigned; use the cluster allocation explain API for that information.

  • recoverysource.type string

    The type of recovery source.

  • completion.size string

    The size of completion.

  • fielddata.memory_size string

    The used fielddata cache memory.

  • fielddata.evictions string

    The fielddata cache evictions.

  • query_cache.memory_size string

    The used query cache memory.

  • query_cache.evictions string

    The query cache evictions.

  • flush.total string

    The number of flushes.

  • flush.total_time string

    The time spent in flush.

  • get.current string

    The number of current get operations.

  • get.time string

    The time spent in get operations.

  • get.total string

    The number of get operations.

  • get.exists_time string

    The time spent in successful get operations.

  • get.exists_total string

    The number of successful get operations.

  • get.missing_time string

    The time spent in failed get operations.

  • get.missing_total string

    The number of failed get operations.

  • indexing.delete_current string

    The number of current deletion operations.

  • indexing.delete_time string

    The time spent in deletion operations.

  • indexing.delete_total string

    The number of delete operations.

  • indexing.index_current string

    The number of current indexing operations.

  • indexing.index_time string

    The time spent in indexing operations.

  • indexing.index_total string

    The number of indexing operations.

  • indexing.index_failed string

    The number of failed indexing operations.

  • merges.current string

    The number of current merge operations.

  • merges.current_docs string

    The number of current merging documents.

  • merges.current_size string

    The size of current merge operations.

  • merges.total string

    The number of completed merge operations.

  • merges.total_docs string

    The nuber of merged documents.

  • merges.total_size string

    The size of current merges.

  • merges.total_time string

    The time spent merging documents.

  • refresh.total string

    The total number of refreshes.

  • refresh.time string

    The time spent in refreshes.

  • refresh.external_total string

    The total nunber of external refreshes.

  • refresh.external_time string

    The time spent in external refreshes.

  • refresh.listeners string

    The number of pending refresh listeners.

  • search.fetch_current string

    The current fetch phase operations.

  • search.fetch_time string

    The time spent in fetch phase.

  • search.fetch_total string

    The total number of fetch operations.

  • search.open_contexts string

    The number of open search contexts.

  • search.query_current string

    The current query phase operations.

  • search.query_time string

    The time spent in query phase.

  • search.query_total string

    The total number of query phase operations.

  • search.scroll_current string

    The open scroll contexts.

  • search.scroll_time string

    The time scroll contexts were held open.

  • search.scroll_total string

    The number of completed scroll contexts.

  • segments.count string

    The number of segments.

  • segments.memory string

    The memory used by segments.

  • segments.index_writer_memory string

    The memory used by the index writer.

  • segments.version_map_memory string

    The memory used by the version map.

  • segments.fixed_bitset_memory string

    The memory used by fixed bit sets for nested object field types and export type filters for types referred in _parent fields.

  • seq_no.max string

    The maximum sequence number.

  • seq_no.local_checkpoint string

    The local checkpoint.

  • seq_no.global_checkpoint string

    The global checkpoint.

  • warmer.current string

    The number of current warmer operations.

  • warmer.total string

    The total number of warmer operations.

  • warmer.total_time string

    The time spent in warmer operations.

  • path.data string

    The shard data path.

  • path.state string

    The shard state path.

  • bulk.total_operations string

    The number of bulk shard operations.

  • bulk.total_time string

    The time spent in shard bulk operations.

  • bulk.total_size_in_bytes string

    The total size in bytes of shard bulk operations.

  • bulk.avg_time string

    The average time spent in shard bulk operations.

  • bulk.avg_size_in_bytes string

    The average size in bytes of shard bulk operations.

Path parameters

• thread_pool_patterns string | array[string] Required

  A comma-separated list of thread pool names used to limit the request. Accepts wildcard expressions.

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.

• time string

  The unit used to display time values.

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

• 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

  application/json text/plain
  Hide response attributes Show response attributes object

  • node_name string

    The node name.

  • node_id string
  • ephemeral_node_id string

    The ephemeral node identifier.

  • pid string

    The process identifier.

  • host string

    The host name for the current node.

  • ip string

    The IP address for the current node.

  • port string

    The bound transport port for the current node.

  • name string

    The thread pool name.

  • type string

    The thread pool type. Returned values include fixed, fixed_auto_queue_size, direct, and scaling.

  • active string

    The number of active threads in the current thread pool.

  • pool_size string

    The number of threads in the current thread pool.

  • queue string

    The number of tasks currently in queue.

  • queue_size string

    The maximum number of tasks permitted in the queue.

  • rejected string

    The number of rejected tasks.

  • largest string

    The highest number of active threads in the current thread pool.

  • completed string

    The number of completed tasks.

  • core string | null

    The core number of active threads allowed in a scaling thread pool.

    One of:

    string-1 string string-2 string | null

  • max string | null

    The maximum number of active threads allowed in a scaling thread pool.

    One of:

    string-1 string string-2 string | null

  • size string | null

    The number of active threads allowed in a fixed thread pool.

    One of:

    string-1 string string-2 string | null

  • keep_alive string | null

    The thread keep alive time.

    One of:

    string-1 string string-2 string | null

Query parameters

• allow_no_match boolean

  Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the _all string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. If true, it returns an empty transforms array when there are no matches and the subset of results when there are partial matches. If false, the request returns a 404 status code when there are no matches or only partial matches.

• from number

  Skips the specified number of transforms.

• h string | array[string]

  Comma-separated list of column names to display.

• s string | array[string]

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

• time string

  The unit used to display time values.

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

• size number

  The maximum number of transforms to obtain.

Responses

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

  • id string
  • state string

    The status of the transform. Returned values include: aborting: The transform is aborting. failed: The transform failed. For more information about the failure, check thereasonfield. indexing: The transform is actively processing data and creating new documents. started: The transform is running but not actively indexing data. stopped: The transform is stopped. stopping`: The transform is stopping.

  • checkpoint string

    The sequence number for the checkpoint.

  • documents_processed string

    The number of documents that have been processed from the source index of the transform.

  • checkpoint_progress string | null

    The progress of the next checkpoint that is currently in progress.

    One of:

    string-1 string string-2 string | null

  • last_search_time string | null

    The timestamp of the last search in the source indices. This field is shown only if the transform is running.

    One of:

    string-1 string string-2 string | null

  • changes_last_detection_time string | null

    The timestamp when changes were last detected in the source indices.

    One of:

    string-1 string string-2 string | null
  • create_time string

    The time the transform was created.

  • version string
  • source_index string

    The source indices for the transform.

  • dest_index string

    The destination index for the transform.

  • pipeline string

    The unique identifier for the ingest pipeline.

  • description string

    The description of the transform.

  • transform_type string

    The type of transform: batch or continuous.

  • frequency string

    The interval between checks for changes in the source indices when the transform is running continuously.

  • max_page_search_size string

    The initial page size that is used for the composite aggregation for each checkpoint.

  • docs_per_second string

    The number of input documents per second.

  • reason string

    If a transform has a failed state, these details describe the reason for failure.

  • search_total string

    The total number of search operations on the source index for the transform.

  • search_failure string

    The total number of search failures.

  • search_time string

    The total amount of search time, in milliseconds.

  • index_total string

    The total number of index operations done by the transform.

  • index_failure string

    The total number of indexing failures.

  • index_time string

    The total time spent indexing documents, in milliseconds.

  • documents_indexed string

    The number of documents that have been indexed into the destination index for the transform.

  • delete_time string

    The total time spent deleting documents, in milliseconds.

  • documents_deleted string

    The number of documents deleted from the destination index due to the retention policy for the transform.

  • trigger_count string

    The number of times the transform has been triggered by the scheduler. For example, the scheduler triggers the transform indexer to check for updates or ingest new data at an interval specified in the frequency property.

  • pages_processed string

    The number of search or bulk index operations processed. Documents are processed in batches instead of individually.

  • processing_time string

    The total time spent processing results, in milliseconds.

  • checkpoint_duration_time_exp_avg string

    The exponential moving average of the duration of the checkpoint, in milliseconds.

  • indexed_documents_exp_avg string

    The exponential moving average of the number of new documents that have been indexed.

  • processed_documents_exp_avg string

    The exponential moving average of the number of documents that have been processed.

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

    Additional properties are allowed.

    Hide cluster_info attributes Show cluster_info attributes object

    • nodes object Required
      Hide nodes attribute Show nodes attribute object

      • * object Additional properties

        Additional properties are allowed.

        Hide * attributes Show * attributes object

        • node_name string Required
        • least_available object Required

          Additional properties are allowed.

          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

          Additional properties are allowed.

          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

    Additional properties are allowed.

    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

      Additional properties are allowed.

      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

    Additional properties are allowed.

    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

Query parameters

• master_timeout string

  Period to wait for a connection to the master node.

• wait_for_removal boolean

  Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list. Defaults to true, meaning that all excluded nodes must be removed from the cluster before this API takes any action. If set to false then the voting configuration exclusions list is cleared even if some excluded nodes are still in the cluster.

Responses

• 200 application/json

Path parameters

• metric string | array[string] Required

  Limit the information returned to the specified metrics

• index string | array[string] Required

  A comma-separated list of index names; use _all or empty string to perform the operation on all indices

Query parameters

• allow_no_indices boolean

  Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

• expand_wildcards string | array[string]

  Whether to expand wildcard expression to concrete indices that are open, closed or both.

• flat_settings boolean

  Return settings in flat format (default: false)

• ignore_unavailable boolean

  Whether specified concrete indices should be ignored when unavailable (missing or closed)

• local boolean

  Return local information, do not retrieve the state from master node (default: false)

• master_timeout string

  Specify timeout for connection to master

• wait_for_metadata_version number

  Wait for the metadata version to be equal or greater than the specified metadata version

• wait_for_timeout string

  The maximum time to wait for wait_for_metadata_version before timing out

Responses

• 200 application/json

  Additional properties are allowed.