elasticsearch get-tasks
Get tasks currently executing in the cluster.
Description
Returns information about the tasks currently executing on one or more nodes in the cluster.
Synopsis
elasticsearch get-tasks
[--site <site>]
[--cluster <cluster>]
[--filter_path <filter_path>]
[--raw]
[--task <task>]
[--actions <actions>]
[--detailed]
[--node <node>]
Arguments
site
- (string)
Site where this command will be executed
Example: --site "site-1"
Default: input.site
Attributes: optional
cluster
- (string)
Name of elastic search cluster
Example: --cluster "elastic-default"
Default: elastic-default
Attributes: optional
filter_path
- (string)
Path in the response. Filters and returns only parts of response matching this path
Example: --filter_path "index.mappings.properties.*"
Default: _None_
Attributes: optional, multiple allowed
raw
- (bool)
If false, returns compact and aligned text output
Example: --raw
Default: _None_
Attributes: optional
task
- (string)
Task Id
Example: --task "oTUltX4IQMOUUVeiohTt8A:124"
Default: _None_
Attributes: optional
actions
- (string)
Used to limit the list of actions returned
Example: --actions "cluster:*, *search"
Default: _None_
Attributes: optional, multiple allowed
detailed
- (bool)
If set, response returns detailed information of the task
Example: --detailed
Default: _None_
Attributes: optional
node
- (string)
Node IDs or names used to limit returned information.
Example: --node "node-1"
Default: _None_
Attributes: optional, multiple allowed
Examples
elasticsearch get-tasks --filter_path "index.mappings.properties." --raw --task "oTUltX4IQMOUUVeiohTt8A:124" --actions "cluster:, *search" --detailed --node "node-1"
Access Control
To use this command, you need access to the following:
Field | Value |
---|---|
Action | "read" |
Service Type | "elasticsearch" |
Service Instance | cluster |
Namespace | |
Object Type | "task" |
Object ID |
Please see Access Control for details.