2019-09-06 18:09:57 +02:00
|
|
|
[[start-resume-reindex]]
|
|
|
|
=== Start or resume reindex API
|
|
|
|
++++
|
|
|
|
<titleabbrev>Start or resume reindex</titleabbrev>
|
|
|
|
++++
|
2019-02-13 21:12:19 +01:00
|
|
|
|
2020-03-20 22:33:20 +01:00
|
|
|
experimental[] Start a new reindex or resume a paused reindex.
|
2019-02-13 21:12:19 +01:00
|
|
|
|
2020-03-20 11:44:35 +01:00
|
|
|
Start a new reindex or resume a paused reindex.
|
|
|
|
|
2019-09-06 18:09:57 +02:00
|
|
|
[[start-resume-reindex-request]]
|
|
|
|
==== Request
|
2019-02-13 21:12:19 +01:00
|
|
|
|
2020-03-20 22:33:20 +01:00
|
|
|
`POST <kibana host>:<port>/api/upgrade_assistant/reindex/myIndex`
|
2019-02-13 21:12:19 +01:00
|
|
|
|
2019-09-06 18:09:57 +02:00
|
|
|
[[start-resume-reindex-codes]]
|
|
|
|
==== Response code
|
2019-02-13 21:12:19 +01:00
|
|
|
|
2019-09-06 18:09:57 +02:00
|
|
|
`200`::
|
|
|
|
Indicates a successful call.
|
2019-02-13 21:12:19 +01:00
|
|
|
|
2019-09-06 18:09:57 +02:00
|
|
|
[[start-resume-reindex-example]]
|
|
|
|
==== Example
|
2019-02-13 21:12:19 +01:00
|
|
|
|
2019-09-06 18:09:57 +02:00
|
|
|
The API returns the following:
|
2019-02-13 21:12:19 +01:00
|
|
|
|
2020-03-20 22:33:20 +01:00
|
|
|
[source,sh]
|
2019-02-13 21:12:19 +01:00
|
|
|
--------------------------------------------------
|
|
|
|
{
|
|
|
|
"indexName": ".ml-state",
|
2019-09-06 18:09:57 +02:00
|
|
|
"newIndexName": ".reindexed-v7-ml-state", <1>
|
|
|
|
"status": 0, <2>
|
|
|
|
"lastCompletedStep": 0, <3>
|
|
|
|
"reindexTaskId": null, <4>
|
|
|
|
"reindexTaskPercComplete": null, <5>
|
|
|
|
"errorMessage": null <6>
|
2019-02-13 21:12:19 +01:00
|
|
|
}
|
|
|
|
--------------------------------------------------
|
|
|
|
|
2020-03-20 22:33:20 +01:00
|
|
|
<1> The name of the new index.
|
|
|
|
<2> The reindex status. For more information, refer to <<status-code,Status codes>>.
|
|
|
|
<3> The last successfully completed step of the reindex. For more information, refer to <<step-code,Step codes>>.
|
|
|
|
<4> The task ID of the reindex task in {es}. Appears when the reindexing starts.
|
|
|
|
<5> The progress of the reindexing task in {es}. Appears in decimal form, from 0 to 1.
|
|
|
|
<6> The error that caused the reindex to fail, if it failed.
|