From 687e03273cb0d7018fb6a56894fbbf2275acc0e2 Mon Sep 17 00:00:00 2001 From: Archer Date: Thu, 12 Dec 2024 14:51:07 -0600 Subject: [PATCH 1/2] Add tuning your cluster. Signed-off-by: Archer --- .../query-group-lifecycle-api.md | 73 +++++++++++++------ 1 file changed, 52 insertions(+), 21 deletions(-) diff --git a/_tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md b/_tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md index 0fb0b0b65c..2711874f07 100644 --- a/_tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md +++ b/_tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md @@ -10,15 +10,59 @@ grand_parent: Availability and recovery The Query Group Lifecycle API creates, updates, retrieves, and deletes query groups. The API categorizes queries into specific groups, called _query groups_, based on desired resource limits. -## Path and HTTP methods +## Paths and HTTP methods +The following paths and methods are supported for the Query Group Lifecycle API. + +### Create a query group + + ```json -PUT _wlm/query_group -PUT _wlm/query_group/ -GET _wlm/query_group -GET _wlm/query_group/ -DELETE _wlm/query_group/ +PUT /_wlm/query_group +``` + + +### Update a query group + + +```json +PUT /_wlm/query_group ``` + + +### Get a query group + + +```json +GET /_wlm/query_group +GET /_wlm/query_group/{name} +``` + + +### Delete a query group + + +```json +PUT /_wlm/query_group +``` + + ## Request body fields @@ -35,7 +79,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 @@ -50,7 +94,7 @@ PUT _wlm/query_group ``` {% include copy-curl.html %} -### Updating a query group +### Update a query group ```json PUT _wlm/query_group/analytics @@ -64,19 +108,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 From f13c696d0b7f945f619609b17155fce085cacf41 Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Thu, 12 Dec 2024 15:26:06 -0600 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- .../workload-management/query-group-lifecycle-api.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/_tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md b/_tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md index 2711874f07..b494ee1699 100644 --- a/_tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md +++ b/_tuning-your-cluster/availability-and-recovery/workload-management/query-group-lifecycle-api.md @@ -10,9 +10,8 @@ grand_parent: Availability and recovery The Query Group Lifecycle API 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 methods +## Path and HTTP methods -The following paths and methods are supported for the Query Group Lifecycle API. ### Create a query group