工作负载组生命周期 API
工作负载组生命周期 API 用于创建、更新、检索和删除工作负载组。该 API 根据期望的资源限制将查询分类到特定的组中,这些组称为工作负载组。
端点
创建工作负载组
PUT /_wlm/query_group
更新工作负载组
PUT /_wlm/query_group
获取工作负载组
GET /_wlm/query_group
GET /_wlm/query_group/{name}
删除工作负载组
PUT /_wlm/query_group
请求正文字段
字段 | 描述 |
---|---|
_id | 工作负载组的 ID,可用于将查询请求与该组关联并强制执行该组的资源限制。 |
名称 | 工作负载组的名称。 |
resiliency_mode | 工作负载组的弹性模式。有效模式包括 enforced 、soft 和 monitor 。有关弹性模式的更多信息,请参阅操作模式。 |
resource_limits | 工作负载组中查询请求的资源限制。有效资源包括 cpu 和 memory 。 |
创建工作负载组时,请确保单个资源(无论是 cpu
还是 memory
)的资源限制总和不超过 1。
示例请求
以下示例请求展示了如何使用工作负载组生命周期 API。
创建工作负载组
PUT _wlm/workload_group
{
"name": "analytics",
"resiliency_mode": "enforced",
"resource_limits": {
"cpu": 0.4,
"memory": 0.2
}
}
更新工作负载组
PUT _wlm/workload_group/analytics
{
"resiliency_mode": "monitor",
"resource_limits": {
"cpu": 0.41,
"memory": 0.21
}
}
示例响应
OpenSearch 返回类似如下的响应。
创建工作负载组
{
"_id":"preXpc67RbKKeCyka72_Gw",
"name":"analytics",
"resiliency_mode":"enforced",
"resource_limits":{
"cpu":0.4,
"memory":0.2
},
"updated_at":1726270184642
}
更新工作负载组
{
"_id":"preXpc67RbKKeCyka72_Gw",
"name":"analytics",
"resiliency_mode":"monitor",
"resource_limits":{
"cpu":0.41,
"memory":0.21
},
"updated_at":1726270333804
}
响应正文字段
字段 | 描述 |
---|---|
_id | 工作负载组的 ID。 |
名称 | 工作负载组的名称。创建新的工作负载组时必需。 |
resiliency_mode | 工作负载组的弹性模式。 |
resource_limits | 工作负载组的资源限制。 |
updated_at | 工作负载组上次更新的时间。 |