获取集群中待处理的任务列表,这些任务通常包括需要修改集群状态的操作。
API #
GET /_cluster/pending_tasks
API 的作用 #
该 API 用于获取集群中待处理的任务列表。它会返回当前在主节点上等待执行的所有集群任务。
待办任务类型 #
待办任务通常包括以下需要修改集群状态的操作:
- 创建索引
- 更新设置
- 分配分片
- 删除索引
- 更新映射
- 其他集群元数据变更
API 的参数 #
Query String 参数 #
| 参数 | 类型 | 是否必填 | 默认值 | 描述 |
|---|---|---|---|---|
master_timeout | 时间值 | 否 | 30s | 等待主节点响应的超时时间 |
local | 布尔值 | 否 | false | 是否从本地节点获取信息,而不是从主节点 |
示例 #
获取待办任务列表 #
GET /_cluster/pending_tasks
响应示例:
{
"tasks": [
{
"insert_order": 1,
"priority": "HIGH",
"source": "indices:index[catalog],cause[api]",
"executing": false,
"time_in_queue_millis": 100,
"time_in_queue": "100ms"
},
{
"insert_order": 2,
"priority": "URGENT",
"source": "remove-dangling-index[index_name]",
"executing": true,
"time_in_queue_millis": 50,
"time_in_queue": "50ms"
}
]
}
设置超时时间 #
GET /_cluster/pending_tasks?master_timeout=1m
从本地节点获取信息 #
GET /_cluster/pending_tasks?local=true
响应字段说明 #
| 字段 | 类型 | 描述 |
|---|---|---|
insert_order | 整数 | 任务插入队列的顺序号 |
priority | 字符串 | 任务优先级,如 URGENT、HIGH、NORMAL、LOW、LANGUID |
source | 字符串 | 任务来源描述 |
executing | 布尔值 | 任务是否正在执行 |
time_in_queue_millis | 整数 | 任务在队列中的等待时间(毫秒) |
time_in_queue | 字符串 | 任务在队列中的等待时间(可读格式) |
任务优先级 #
| 优先级 | 描述 |
|---|---|
URGENT | 紧急任务,最高优先级 |
HIGH | 高优先级任务 |
NORMAL | 普通优先级任务 |
LOW | 低优先级任务 |
LANGUID | 延迟任务,最低优先级 |
相关 API #
/_cat/pending_tasks:以表格形式显示相同的待处理任务信息GET /_cluster/health:获取集群健康状态GET /_cluster/state:获取集群状态





