Skip to content

Commit 5a787b6

Browse files
Update optimize_shards_placement.md (#1103)
Adding omitted `/v1` prepend to REST API URL
1 parent f7ba013 commit 5a787b6

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

content/operate/rs/references/rest-api/requests/bdbs/actions/optimize_shards_placement.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Get optimized shards placement for the given database.
3535
#### Example HTTP request
3636

3737
```sh
38-
GET /bdbs/1/actions/optimize_shards_placement
38+
GET /v1/bdbs/1/actions/optimize_shards_placement
3939
```
4040

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

5656
```sh
57-
GET /bdbs/1/actions/optimize_shards_placement?shards_count=10&memory_size=10000
57+
GET /v1/bdbs/1/actions/optimize_shards_placement?shards_count=10&memory_size=10000
5858
```
5959

6060
### Response {#get-response}
6161

62-
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.
62+
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.
6363

6464
#### Example JSON body
6565

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

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

127-
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.
127+
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.
128128

129-
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.
129+
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.
130130

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

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

137137
```sh
138-
PUT /bdbs/1
138+
PUT /v1/bdbs/1
139139
```
140140

141141
#### Headers

0 commit comments

Comments
 (0)