Skip to content

Commit

Permalink
Add tuning your cluster automation (#8953) (#8954)
Browse files Browse the repository at this point in the history
  • Loading branch information
opensearch-trigger-bot[bot] authored Dec 12, 2024
1 parent 11b7504 commit 6d9581d
Showing 1 changed file with 50 additions and 20 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,56 @@ The Query Group Lifecycle API creates, updates, retrieves, and deletes query gro

## Path and HTTP methods


### Create a query group

<!-- spec_insert_start
api: wlm.create_query_group
component: paths_and_http_methods
omit_header: true
-->
```json
PUT _wlm/query_group
PUT _wlm/query_group/<name>
GET _wlm/query_group
GET _wlm/query_group/<name>
DELETE _wlm/query_group/<name>
PUT /_wlm/query_group
```
<!-- spec_insert_end -->

### Update a query group

<!-- spec_insert_start
api: wlm.create_query_group
component: paths_and_http_methods
omit_header: true
-->
```json
PUT /_wlm/query_group
```
<!-- spec_insert_end -->

### Get a query group

<!-- spec_insert_start
api: wlm.get_query_group
component: paths_and_http_methods
omit_header: true
-->
```json
GET /_wlm/query_group
GET /_wlm/query_group/{name}
```
<!-- spec_insert_end -->

### Delete a query group

<!-- spec_insert_start
api: wlm.create_query_group
component: paths_and_http_methods
omit_header: true
-->
```json
PUT /_wlm/query_group
```
<!-- spec_insert_end -->


## Request body fields

Expand All @@ -35,7 +78,7 @@ When creating a query group, make sure that the sum of the resource limits for a

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

### Creating a query group
### Create a query group

```json
PUT _wlm/query_group
Expand All @@ -50,7 +93,7 @@ PUT _wlm/query_group
```
{% include copy-curl.html %}

### Updating a query group
### Update a query group

```json
PUT _wlm/query_group/analytics
Expand All @@ -64,19 +107,6 @@ PUT _wlm/query_group/analytics
```
{% include copy-curl.html %}

### Getting a query group

```json
GET _wlm/query_group/analytics
```
{% include copy-curl.html %}

### Deleting a query group

```json
DELETE _wlm/query_group/analytics
```
{% include copy-curl.html %}

## Example responses

Expand Down

0 comments on commit 6d9581d

Please sign in to comment.