Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
---
layout: default
title: Query group lifecycle API
nav_order: 20
parent: Workload management
grand_parent: Availability and recovery
---

# Query Group Lifecycle API

Check failure on line 9 in _tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md

View workflow job for this annotation

GitHub Actions / style-job

[vale] reported by reviewdog 🐶 [OpenSearch.HeadingCapitalization] 'Query Group Lifecycle API' is a heading and should be in sentence case. Raw Output: {"message": "[OpenSearch.HeadingCapitalization] 'Query Group Lifecycle API' is a heading and should be in sentence case.", "location": {"path": "_tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md", "range": {"start": {"line": 9, "column": 3}}}, "severity": "ERROR"}

The Query Group Lifecycle API in creates, updates, retrieves, and deletes query groups. The API categorizes queries into specific groups, called _query groups_ based on desired resource limits.

## Paths and HTTP method

```json
PUT _wlm/query_group
PUT _wlm/query_group/<name>
GET _wlm/query_group
GET _wlm/query_group/<name>
DELETE _wlm/query_group/<name>
```

## Request body fields

| Field | Description |
| :--- | :--- |
| `_id` | The ID of the query group, which can be used to associate query requests with the group and enforce the group's resource limits. |
| `name` | The name of the query group. |
| `resiliency_mode` | The resiliency mode of the query group. Valid modes are `enforced`, `soft`, and `monitor`. For more information about resiliency modes, see [Operating modes](https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/workload-management/wlm-feature-overview/#operating-modes). |
| `resource_limits` | The resource limits for query requests in the query group. Valid resources are `cpu` and `memory`. |

When creating a query group, make sure that the sum of the resource limits for a single resource, either `cpu` or `memory`, does not exceed 1.

## Example requests

The following requests show how to use the Query Group Lifecycle API.

### Creating a query group

```json
PUT _wlm/query_group
{
"name": "analytics",
"resiliency_mode": "enforced",
"resource_limits": {
"cpu": 0.4,
"memory": 0.2
}
}
```

### Updating a query group

```json
PUT _wlm/query_group/analytics
{
"resiliency_mode": "monitor",
"resource_limits": {
"cpu": 0.41,
"memory": 0.21
}
}
```

### Getting a query group

```json
GET _wlm/query_group/analytics
```

### Deleting a query group

```json
DELETE _wlm/query_group/analytics
```

## Example responses

OpenSearch returns responses similar to the following.

### Creating a query group

```json
{
"_id":"preXpc67RbKKeCyka72_Gw",
"name":"analytics",
"resiliency_mode":"enforced",
"resource_limits":{
"cpu":0.4,
"memory":0.2
},
"updated_at":1726270184642
}
```

### Updating query group

```json
{
"_id":"preXpc67RbKKeCyka72_Gw",
"name":"analytics",
"resiliency_mode":"monitor",
"resource_limits":{
"cpu":0.41,
"memory":0.21
},
"updated_at":1726270333804
}
```

## Response body fields

| Field | Description |
| :--- | :--- |
| `_id` | The ID of the query group. |
| `name` | The name of the query group. Required when creating a new query group. |
| `resiliency_mode` | The resiliency mode of the query group. |
| `resource_limits` | The resource limits of the query group. |
| `updated_at` | The time at which the query group was last updated. |


Loading