Link Search Menu Expand Document Documentation Menu

You're viewing version 2.5 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.


The Asynchronous Search plugin adds several settings to the standard OpenSearch cluster settings. They are dynamic, so you can change the default behavior of the plugin without restarting your cluster. You can mark the settings as persistent or transient.

For example, to update the retention period of the result index:

PUT _cluster/settings
  "transient": {
    "plugins.asynchronous_search.max_wait_for_completion_timeout": "5m"
Setting Default Description
plugins.asynchronous_search.max_search_running_time 12 hours The maximum running time for the search beyond which the search is terminated.
plugins.asynchronous_search.node_concurrent_running_searches 20 The concurrent searches running per coordinator node.
plugins.asynchronous_search.max_keep_alive 5 days The maximum amount of time that search results can be stored in the cluster.
plugins.asynchronous_search.max_wait_for_completion_timeout 1 minute The maximum value for the wait_for_completion_timeout parameter.
plugins.asynchronous_search.persist_search_failures false Persist asynchronous search results that end with a search failure in the system index.
350 characters left

Have a question? .

Want to contribute? or .