创建工作负载组规则

用于 workload_group 特征类型的创建工作负载组规则 API 允许您定义、更新、检索和删除自动将工作负载组 ID 分配给传入查询的规则。当查询匹配规则中指定的属性时，OpenSearch 会使用相应的工作负载组 ID 标记该查询。这消除了客户端在每个请求中手动包含工作负载组 ID 的需要。

支持的属性

下表列出了 workload_group 特征类型支持的属性。

示例请求

以下示例演示了如何使用创建工作负载组规则 API 为 workload_group 特征类型创建规则。

创建规则

以下请求创建一个规则，当 index_pattern 属性匹配时，该规则分配一个 workload_group 值

PUT _rules/workload_group
{
  "description": "description for rule",
  "index_pattern": ["log*", "event*"],
  "workload_group": "EITBzjFkQ6CA-semNWGtRQ"
}

更新规则

以下请求更新 ID 为 0A6RULxkQ9yLqn4r8LPrIg 的规则

PUT _rules/workload_group/0A6RULxkQ9yLqn4r8LPrIg
{
  "description": "updated_description for rule",
  "index_pattern": ["log*"],
  "workload_group": "EITBzjFkQ6CA-semNWGtRQ"
}

您不能更改 feature_type。您可以省略任何不想更新的字段。

获取规则

您可以通过规则 ID、属性过滤器或使用分页来检索使用创建工作负载组规则 API 创建的规则。

以下请求通过 ID 检索 workload_group 特征类型的规则

GET /_rules/workload_group/{id}

以下请求检索 workload_group 特征类型的所有规则

GET /_rules/workload_group

以下请求检索 workload_group 特征类型中 index_pattern 属性匹配 a 或 b 的所有规则

GET /_rules/workload_group?index_pattern=a,b

如果响应包含的结果多于一页所能容纳的数量，OpenSearch 会对结果进行分页并在响应中包含一个 search_after 值。要检索下一页，请使用相同的过滤器向相同的端点发送另一个请求，并包含前一个响应中的 search_after 值作为查询参数。

以下请求提供了来自同一工作负载组的下一页规则

"GET /_rules/workload_group?index_pattern=a,b&search_after=z1MJApUB0zgMcDmz-UQq"

删除规则

以下请求使用规则的 ID 删除规则

DELETE /_rules/workload_group/{id}

示例响应

{
  "id": "wi6VApYBoX5wstmtU_8l",
  "description": "description for rule",
  "index_pattern": ["log*", "event*"],
  "workload_group": "EITBzjFkQ6CA-semNWGtRQ",
  "updated_at": "2025-04-04T20:54:22.406Z"
}

{
  "rules": [
    {
      "id": "z1MJApUB0zgMcDmz-UQq",
      "description": "Rule for tagging workload_group_id to index123",
      "index_pattern": ["index123"],
      "workload_group": "workload_group_id",
      "updated_at": "2025-02-14T01:19:22.589Z"
    },
    ...
  ],
  "search_after": ["z1MJApUB0zgMcDmz-UQq"]
}

{ "acknowledged": true }