Get data streams | Elasticsearch API documentation (original) (raw)

Dismiss highlight Show more

Query parameters

• Type of data stream that wildcard patterns can match. Supports comma-separated values, such as open,hidden.
  Supported values include:
  • all: Match any data stream or index, including hidden ones.
  • open: Match open, non-hidden indices. Also matches any non-hidden data stream.
  • closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
  • hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both.
  • none: Wildcard expressions are not accepted.
• If true, returns all relevant default configurations for the index template.
• 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.
• Whether the maximum timestamp for each data stream should be calculated and returned.

Responses

• 200 application/json
  Hide response attribute Show response attribute object
  • Hide data_streams attributes Show data_streams attributes object
    * Hide _meta attribute Show _meta attribute object
    * *
    object Additional properties
    * If true, the data stream allows custom routing on write request.
    * Hide failure_store attributes Show failure_store attributes object
    * Hide indices attributes Show indices attributes object
    * Values are Index Lifecycle Management, Data stream lifecycle, or Unmanaged.
    * Indicates if ILM should take precedence over DSL in case both are configured to manage this index.
    * Values are standard, time_series, logsdb, or lookup.
    * Current generation for the data stream. This number acts as a cumulative count of the stream’s rollovers, starting at 1.
    * If true, the data stream is hidden.
    * Values are Index Lifecycle Management, Data stream lifecycle, or Unmanaged.
    * Indicates if ILM should take precedence over DSL in case both are configured to managed this data stream.
    * Array of objects containing information about the data stream’s backing indices. The last item in this array contains information about the stream’s current write index.
    Hide indices attributes Show indices attributes object
    * Values are Index Lifecycle Management, Data stream lifecycle, or Unmanaged.
    * Indicates if ILM should take precedence over DSL in case both are configured to manage this index.
    * Values are standard, time_series, logsdb, or lookup.
    * Hide lifecycle attributes Show lifecycle attributes object
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * Hide downsampling attribute Show downsampling attribute object
    * The list of downsampling rounds to execute as part of this downsampling configuration
    * If defined, it turns data stream lifecycle on/off (true/false) for this data stream. A data stream lifecycle that's disabled (enabled: false) will have no effect on the data stream.
    * Hide rollover attributes Show rollover attributes object
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * If true, the data stream is created and managed by cross-cluster replication and the local cluster can not write into this data stream or change its mappings.
    * If true, the next write to this data stream will trigger a rollover first and the document will be indexed in the new backing index. If the rollover fails the indexing request will fail too.
    * Values are green, GREEN, yellow, YELLOW, red, or RED.
    * If true, the data stream is created and managed by an Elastic stack component and cannot be modified through normal user interaction.
    * Hide timestamp_field attribute Show timestamp_field attribute object
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Values are standard, time_series, logsdb, or lookup.