kibana/docs/api/upgrade-assistant/reindexing.asciidoc
Kaarina Tungseth fda3196611
[DOCS] Updates API requests and examples (#60695)
* [DOCS] Updates API requests and examples

* Review comments
2020-03-20 16:33:20 -05:00

46 lines
1.3 KiB
Plaintext

[[start-resume-reindex]]
=== Start or resume reindex API
++++
<titleabbrev>Start or resume reindex</titleabbrev>
++++
experimental[] Start a new reindex or resume a paused reindex.
Start a new reindex or resume a paused reindex.
[[start-resume-reindex-request]]
==== Request
`POST <kibana host>:<port>/api/upgrade_assistant/reindex/myIndex`
[[start-resume-reindex-codes]]
==== Response code
`200`::
Indicates a successful call.
[[start-resume-reindex-example]]
==== Example
The API returns the following:
[source,sh]
--------------------------------------------------
{
"indexName": ".ml-state",
"newIndexName": ".reindexed-v7-ml-state", <1>
"status": 0, <2>
"lastCompletedStep": 0, <3>
"reindexTaskId": null, <4>
"reindexTaskPercComplete": null, <5>
"errorMessage": null <6>
}
--------------------------------------------------
<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.