Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add tuning your cluster automation #8953

Merged
merged 2 commits into from
Dec 12, 2024
Merged

Add tuning your cluster automation #8953

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
687e032
Add tuning your cluster.
Naarcha-AWS Dec 12, 2024
f13c696
Apply suggestions from code review
Naarcha-AWS Dec 12, 2024
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
70 changes: 50 additions & 20 deletions ...ster/availability-and-recovery/workload-management/query-group-lifecycle-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,56 @@

## Path and HTTP methods


### Create a query group

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

View workflow job for this annotation

GitHub Actions / vale

[vale] _tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md#L16 

[OpenSearch.StackedHeadings] Do not stack headings. Insert an introductory sentence between headings.
Raw output 
{"message": "[OpenSearch.StackedHeadings] Do not stack headings. Insert an introductory sentence between headings.", "location": {"path": "_tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md", "range": {"start": {"line": 16, "column": 1}}}, "severity": "ERROR"}

<!-- 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 @@

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 @@
```
{% include copy-curl.html %}

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

```json
PUT _wlm/query_group/analytics
Expand All @@ -64,19 +107,6 @@
```
{% 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
Loading