Get datafeeds configuration info | Elasticsearch API documentation (original) (raw)

Dismiss highlight Show more

Query parameters

• Specifies what to do when the request:
  1. Contains wildcard expressions and there are no datafeeds that match.
  2. Contains the _all string or no identifiers and there are no matches.
  3. Contains wildcard expressions and there are only partial matches.
     The default value is true, which returns an empty datafeeds array when there are no matches and the subset of results when there are partial matches. If this parameter is false, the request returns a404 status code when there are no matches or only partial matches.
• Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster.

Responses

• 200 application/json
  Hide response attributes Show response attributes object
  • Hide datafeeds attributes Show datafeeds attributes object
    * Hide authorization attributes Show authorization attributes object
    * Hide api_key attributes Show api_key attributes object
    * The name of the API key.
    * If a user ID was used for the most recent update to the datafeed, its roles at the time of the update are listed in the response.
    * If a service account was used for the most recent update to the datafeed, the account name is listed in the response.
    * Hide chunking_config attributes Show chunking_config attributes object
    * Values are auto, manual, or off.
    * 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.
    * 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.
    * 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 script_fields attribute Show script_fields attribute object
    * *
    object Additional properties
    Hide * attributes Show * attributes object
    * Hide script attributes Show script attributes object
    * Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.
    * Hide delayed_data_check_config attributes Show delayed_data_check_config 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.
    * Specifies whether the datafeed periodically checks for delayed data.
    * Hide runtime_mappings attribute Show runtime_mappings attribute object
    * *
    object Additional properties
    Hide * attributes Show * attributes object
    * For type composite
    Hide fields attribute Show fields attribute object
    * *
    object Additional properties
    * For type lookup
    * A custom format for date type runtime fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
    * Hide script attributes Show script attributes object
    * Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.
    * Values are boolean, composite, date, double, geo_point, geo_shape, ip, keyword, long, or lookup.
    * Hide indices_options attributes Show indices_options attributes object
    * If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.
    * If true, missing or closed indices are not included in the response.
    * If true, concrete, expanded or aliased indices are ignored when frozen.
    * The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. By default, this property has the following value: {"match_all": {"boost": 1}}.
    Query DSL