列出任务
1.0 版引入
List Tasks API 返回集群中正在运行的任务列表。
端点
GET /_tasks
查询参数
下表列出了可用的查询参数。所有查询参数都是可选的。
参数 | 数据类型 | 描述 | 默认值 |
---|---|---|---|
actions | 列表或字符串 | 要返回的操作的逗号分隔列表。留空以返回所有操作。 | 不适用 |
detailed | 布尔型 | 当为 true 时,响应包含关于分片恢复的详细信息。 | false |
group_by | 字符串 | 按父/子关系或节点对任务进行分组。 有效值为: nodes 、none 和 parents 。 | 节点 |
节点 | 列表 | 用于限制返回信息的节点 ID 或名称的逗号分隔列表。使用 _local 返回您连接的节点的信息,指定节点名称以获取特定节点的信息,或者将参数留空以获取所有节点的信息。 | 不适用 |
parent_task_id | 字符串 | 返回具有指定父任务 ID(node_id:task_number )的任务。留空或设置为 -1 以返回所有任务。 | 不适用 |
timeout | 字符串 | 等待响应的时间量。 | 不适用 |
wait_for_completion | 布尔型 | 等待匹配的任务完成。当为 true 时,请求将阻塞直到任务完成。 | false |
请求示例
以下请求返回当前在名为 opensearch-node1
的节点上运行的任务
GET /_tasks?nodes=opensearch-node1
示例响应
以下响应提供有关运行任务的信息
{
"nodes": {
"Mgqdm0r9SEGClWxp_RbnaQ": {
"name": "opensearch-node1",
"transport_address": "sample_address",
"host": "sample_host",
"ip": "sample_ip",
"roles": [
"data",
"ingest",
"master",
"remote_cluster_client"
],
"tasks": {
"Mgqdm0r9SEGClWxp_RbnaQ:24578": {
"node": "Mgqdm0r9SEGClWxp_RbnaQ",
"id": 24578,
"type": "transport",
"action": "cluster:monitor/tasks/lists",
"start_time_in_millis": 1611612517044,
"running_time_in_nanos": 638700,
"cancellable": false,
"headers": {}
},
"Mgqdm0r9SEGClWxp_RbnaQ:24579": {
"node": "Mgqdm0r9SEGClWxp_RbnaQ",
"id": 24579,
"type": "direct",
"action": "cluster:monitor/tasks/lists[n]",
"start_time_in_millis": 1611612517044,
"running_time_in_nanos": 222200,
"cancellable": false,
"parent_task_id": "Mgqdm0r9SEGClWxp_RbnaQ:24578",
"headers": {}
}
}
}
}
}
resource_stats
对象
resource_stats
对象仅针对支持资源跟踪的任务进行更新。这些统计数据是根据计划的线程执行计算的,包括已完成任务工作的线程和当前正在任务工作的线程。由于同一个线程可能被多次调度到同一个任务上工作,因此每个给定线程被调度到给定任务上工作的实例都被视为一次单个线程执行。
下表列出了 resource_stats
对象中的所有响应字段。
响应字段 | 描述 |
---|---|
average | 所有计划线程执行的平均资源使用量。 |
total | 所有计划线程执行的总资源使用量。 |
min | 所有计划线程执行的最小资源使用量。 |
max | 所有计划线程执行的最大资源使用量。 |
thread_info | 线程计数相关统计。 |
thread_info.active_threads | 当前正在任务上工作的线程数。 |
thread_info.thread_executions | 已计划在任务上工作的线程数。 |