Task Management API · Elasticsearch 5.4 中文文檔

# Task Management API 原文鏈接 : [https://www.elastic.co/guide/en/elasticsearch/reference/5.0/tasks.html](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/tasks.html) 譯文鏈接 : [http://www.apache.wiki/display/Elasticsearch/Task+Management+API](http://www.apache.wiki/display/Elasticsearch/Task+Management+API) 貢獻者 : [那伊抹微笑](/display/~wangyangting) 警告 : 該 Task Management API 是一個新功能，并且仍然處于實驗階段，該 API 可能會改變方式并且不向后兼容。 ## Current Tasks Information（當前任務信息） **task management API** 可以獲取關于集群中一個或多個節點正在執行中的任務的信息。 ``` curl -XGET 'localhost:9200/_tasks ?pretty'① curl -XGET 'localhost:9200/_tasks?nodes=nodeId1,nodeId2 &pretty'② curl -XGET 'localhost:9200/_tasks?nodes=nodeId1,nodeId2&actions=cluster:* &pretty'③ ``` | 編號 | 描述 | | --- | --- | | [![](https://img.kancloud.cn/89/2e/892e2d6105d4361c3e81583c8e019d23_14x15.jpg)](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/tasks.html#CO135-1) | Retrieves all tasks currently running on all nodes in the cluster. | | [![](https://img.kancloud.cn/50/46/50466ab92768bfee2306a5da100c7496_14x15.jpg)](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/tasks.html#CO135-2) | Retrieves all tasks running on nodes?`nodeId1`?and?`nodeId2`. See?[the section called “Node specification](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/cluster.html#cluster-nodes "Node specificationedit")[edit](https://github.com/elastic/elasticsearch/edit/5.0/docs/reference/cluster.asciidoc "Edit this page on GitHub")” for more info about how to select individual nodes. | | [![](https://img.kancloud.cn/59/09/59090687855ebb833c063fe09e622609_14x15.jpg)](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/tasks.html#CO135-3) | Retrieves all cluster-related tasks running on nodes?`nodeId1`?and?`nodeId2`. | 返回結果看起來如下 :? ``` { "nodes" : { "oTUltX4IQMOUUVeiohTt8A" : { "name" : "H5dfFeA", "transport_address" : "127.0.0.1:9300", "host" : "127.0.0.1", "ip" : "127.0.0.1:9300", "tasks" : { "oTUltX4IQMOUUVeiohTt8A:124" : { "node" : "oTUltX4IQMOUUVeiohTt8A", "id" : 124, "type" : "direct", "action" : "cluster:monitor/tasks/lists[n]", "start_time_in_millis" : 1458585884904, "running_time_in_nanos" : 47402, "cancellable" : false, "parent_task_id" : "oTUltX4IQMOUUVeiohTt8A:123" }, "oTUltX4IQMOUUVeiohTt8A:123" : { "node" : "oTUltX4IQMOUUVeiohTt8A", "id" : 123, "type" : "transport", "action" : "cluster:monitor/tasks/lists", "start_time_in_millis" : 1458585884904, "running_time_in_nanos" : 236042, "cancellable" : false } } } } } ``` 也可以獲取指定任務的信息 :? ``` curl -XGET 'localhost:9200/_tasks/task_id:1 ?pretty' ``` | [![](https://img.kancloud.cn/89/2e/892e2d6105d4361c3e81583c8e019d23_14x15.jpg)](https://www.elastic.co/guide/en/elasticsearch/reference/5.0/tasks.html#CO136-1) | This will return a 404 if the task isn’t found. | 或者獲取任務所有子任務的信息 :? ``` curl -XGET 'localhost:9200/_tasks?parent_task_id=parentTaskId:1 &pretty' ``` 如果父任務不存在也不會返回 404 錯誤。該任務 **API** 也可用于等待一個指定的任務完成。在 **id** 為 **oTUltX4IQMOUUVeiohTt8A**?的任務完成之前，下面的調用將鎖住 **10** 秒。 ``` curl -XGET 'localhost:9200/_tasks/oTUltX4IQMOUUVeiohTt8A:12345?wait_for_completion=true&timeout=10s&pretty' ``` 你可以等待所有任務中的某個動作類型直到完成。這個命令將等待所有的 **reindex** 任務直到完成 :? ``` curl -XGET 'localhost:9200/_tasks?actions=*reindex&wait_for_completion=true&timeout=10s&pretty' ``` 可以使用 **_cat** 列出任務命令列表，它接受與標準的 **list task** 命令相同的參數。 ``` curl -XGET 'localhost:9200/_cat/tasks?pretty' ``` ## Task Cancellation（任務取消）如果一個長期運行的任務支持取消，可以通過下列的命令來取消它 :? ``` curl -XPOST 'localhost:9200/_tasks/task_id:1/_cancel?pretty' ``` 該任務取消命令支持和 **list tasks** 命令相同的任務選擇參數，所以多個任務可以在同時取消。例如，下面的命令將取消所有運行在 **nodeId1** 和 **nodeId2** 上的 **reindex** 任務。 ``` curl -XPOST 'localhost:9200/_tasks/_cancel?nodes=nodeId1,nodeId2&actions=*reindex&pretty' ``` ## Task Grouping（任務組）通過使用 **task API** 命令使用 **group_by** 參數可以通過 **nodes**（默認）或者父任務來分組以返回任務列表。下面的命令將改變分組為父任務 :? ``` curl -XGET 'localhost:9200/_tasks?group_by=parents&pretty' ```