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

Update optimize_shards_placement.md #1103

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update optimize_shards_placement.md #1103

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions ...erate/rs/references/rest-api/requests/bdbs/actions/optimize_shards_placement.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Get optimized shards placement for the given database.
#### Example HTTP request

```sh
GET /bdbs/1/actions/optimize_shards_placement
GET /v1/bdbs/1/actions/optimize_shards_placement
```

#### Query parameters
Expand All @@ -54,12 +54,12 @@ Include query parameters in a `GET` request to generate an optimized shard place
The following example request includes `shards_count` and `memory_size` as query parameters:

```sh
GET /bdbs/1/actions/optimize_shards_placement?shards_count=10&memory_size=10000
GET /v1/bdbs/1/actions/optimize_shards_placement?shards_count=10&memory_size=10000
```

### Response {#get-response}

To rearrange the database shards, you can submit the blueprint returned in this response body as the `shards_blueprint` field in the [`PUT` `/bdbs/{uid}`](#put-bdbs-rearrange-shards) request.
To rearrange the database shards, you can submit the blueprint returned in this response body as the `shards_blueprint` field in the [`PUT` `/v1/bdbs/{uid}`](#put-bdbs-rearrange-shards) request.

#### Example JSON body

Expand Down Expand Up @@ -124,9 +124,9 @@ To rearrange the database shards, you can submit the blueprint returned in this

## Rearrange database shards {#put-bdbs-rearrange-shards}

Use the blueprint returned by the [`GET`&nbsp;`/bdbs/{uid}/actions/optimize_shards_placement`]({{< relref "/operate/rs/references/rest-api/requests/bdbs/actions/optimize_shards_placement#get-bdbs-actions-optimize-shards-placement" >}}) request as the value of the `shards_blueprint` field to rearrange the database shards.
Use the blueprint returned by the [`GET`&nbsp;`/v1/bdbs/{uid}/actions/optimize_shards_placement`]({{< relref "/operate/rs/references/rest-api/requests/bdbs/actions/optimize_shards_placement#get-bdbs-actions-optimize-shards-placement" >}}) request as the value of the `shards_blueprint` field to rearrange the database shards.

To ensure that the optimized shard placement is relevant for the current cluster state, pass the `cluster-state-id`, taken from the response header of the `GET` request, in the [`PUT`&nbsp;`/bdbs/{uid}`]({{< relref "/operate/rs/references/rest-api/requests/bdbs#put-bdbs" >}}) request headers.
To ensure that the optimized shard placement is relevant for the current cluster state, pass the `cluster-state-id`, taken from the response header of the `GET` request, in the [`PUT`&nbsp;`/v1/bdbs/{uid}`]({{< relref "/operate/rs/references/rest-api/requests/bdbs#put-bdbs" >}}) request headers.

The cluster will reject the update if its state was changed since the optimal shards placement was obtained.

Expand All @@ -135,7 +135,7 @@ The cluster will reject the update if its state was changed since the optimal sh
#### Example HTTP request

```sh
PUT /bdbs/1
PUT /v1/bdbs/1
```

#### Headers
Expand Down