2c25520051
* First iteration of batch reindex docs Tested with docs generator repo * Add top level bullet points and remove cruft * Address PR feedback Also move the experimental marker to similar position (before description) on existing endpoint docs for UA.
69 lines
1.6 KiB
Plaintext
69 lines
1.6 KiB
Plaintext
[[batch-reindex-queue]]
|
|
=== Batch reindex queue API
|
|
++++
|
|
<titleabbrev>Batch reindex queue</titleabbrev>
|
|
++++
|
|
|
|
experimental["The underlying Upgrade Assistant concepts are stable, but the APIs for managing Upgrade Assistant are experimental."]
|
|
|
|
Check the current reindex batch queue.
|
|
|
|
[[batch-reindex-queue-request]]
|
|
==== Request
|
|
|
|
`GET /api/upgrade_assistant/reindex/batch/queue`
|
|
|
|
[[batch-reindex-queue-request-codes]]
|
|
==== Response code
|
|
|
|
`200`::
|
|
Indicates a successful call.
|
|
|
|
[[batch-reindex-queue-example]]
|
|
==== Example
|
|
|
|
The API returns the following:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
{
|
|
"queue": [ <1>
|
|
{
|
|
"indexName": "index1",
|
|
"newIndexName": "reindexed-v8-index2",
|
|
"status": 3,
|
|
"lastCompletedStep": 0,
|
|
"locked": null,
|
|
"reindexTaskId": null,
|
|
"reindexTaskPercComplete": null,
|
|
"errorMessage": null,
|
|
"runningReindexCount": null,
|
|
"reindexOptions": {
|
|
"queueSettings": {
|
|
"queuedAt": 1583406985489
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"indexName": "index2",
|
|
"newIndexName": "reindexed-v8-index2",
|
|
"status": 3,
|
|
"lastCompletedStep": 0,
|
|
"locked": null,
|
|
"reindexTaskId": null,
|
|
"reindexTaskPercComplete": null,
|
|
"errorMessage": null,
|
|
"runningReindexCount": null,
|
|
"reindexOptions": {
|
|
"queueSettings": {
|
|
"queuedAt": 1583406987334
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
--------------------------------------------------
|
|
|
|
<1> Items in this array indicate reindex tasks at a given point in time and the order in which they will be executed.
|
|
|