› › ›

cat 任务管理 API

编辑

cat 任务管理 API

编辑

cat 任务管理 API 是一个新功能，仍应被视为测试版功能。该 API 可能会以不向后兼容的方式进行更改。有关功能状态，请参阅 #51628。

cat API 仅供人类使用命令行或 Kibana 控制台使用。它们不适用于应用程序使用。对于应用程序使用，请使用任务管理 API。

返回有关集群中当前正在执行的任务的信息，类似于任务管理 API。

请求

编辑

GET /_cat/tasks

先决条件

编辑

如果启用了 Elasticsearch 安全功能，您必须具有 monitor 或 manage 集群权限才能使用此 API。

描述

编辑

cat 任务管理 API 返回有关集群中一个或多个节点上当前正在执行的任务的信息。它是 JSON 任务管理 API 的更紧凑视图。

查询参数

编辑

detailed: （可选，布尔值）如果为 true，则响应包括有关分片恢复的详细信息。默认为 false。
format: （可选，字符串）HTTP accept header 的简短版本。有效值包括 JSON、YAML 等。
h: （可选，字符串）要显示的列名称的逗号分隔列表。
help: （可选，布尔值）如果为 true，则响应包括帮助信息。默认为 false。
nodes: （可选，字符串）用于限制响应的节点 ID 或名称的逗号分隔列表。支持通配符 (*) 表达式。
parent_task_id: （可选，字符串）用于限制响应的父任务 ID。
s: （可选，字符串）用于对响应进行排序的列名称或列别名的逗号分隔列表。
time: （可选，时间单位）用于显示时间值的单位。
v: （可选，布尔值）如果为 true，则响应包括列标题。默认为 false。

响应代码

编辑

404（缺少资源）: 如果指定了 <task_id> 但未找到，则此代码表示没有与请求匹配的资源。

示例

编辑

resp = client.cat.tasks(
    v=True,
)
print(resp)

response = client.cat.tasks(
  v: true
)
puts response

const response = await client.cat.tasks({
  v: "true",
});
console.log(response);

GET _cat/tasks?v=true

该 API 返回以下响应

action                         task_id                    parent_task_id             type      start_time    timestamp running_time ip             node
cluster:monitor/tasks/lists[n] oTUltX4IQMOUUVeiohTt8A:124 oTUltX4IQMOUUVeiohTt8A:123 direct    1458585884904 01:48:24  44.1micros   127.0.0.1:9300 oTUltX4IQMOUUVeiohTt8A
cluster:monitor/tasks/lists    oTUltX4IQMOUUVeiohTt8A:123 -                          transport 1458585884904 01:48:24  186.2micros  127.0.0.1:9300 oTUltX4IQMOUUVeiohTt8A

« cat 快照 API cat 模板 API »