2019-02-13 21:12:19 +01:00
|
|
|
[[upgrade-assistant-api-status]]
|
2019-09-06 18:09:57 +02:00
|
|
|
=== Upgrade readiness status API
|
|
|
|
++++
|
|
|
|
<titleabbrev>Upgrade readiness status</titleabbrev>
|
|
|
|
++++
|
2019-02-13 21:12:19 +01:00
|
|
|
|
2020-03-20 22:33:20 +01:00
|
|
|
experimental[] Check the status of your cluster.
|
2019-09-06 18:09:57 +02:00
|
|
|
|
2020-03-20 11:44:35 +01:00
|
|
|
Check the status of your cluster.
|
|
|
|
|
2019-09-06 18:09:57 +02:00
|
|
|
[[upgrade-assistant-api-status-request]]
|
2019-02-13 21:12:19 +01:00
|
|
|
==== Request
|
|
|
|
|
2020-03-20 22:33:20 +01:00
|
|
|
`GET <kibana host>:<port>/api/upgrade_assistant/status`
|
2019-02-13 21:12:19 +01:00
|
|
|
|
2019-09-06 18:09:57 +02:00
|
|
|
[[upgrade-assistant-api-status-response-codes]]
|
|
|
|
==== Response codes
|
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
|
|
|
[[upgrade-assistant-api-status-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
|
|
|
--------------------------------------------------
|
|
|
|
{
|
|
|
|
"readyForUpgrade": false,
|
|
|
|
"cluster": [
|
|
|
|
{
|
|
|
|
"message": "Cluster deprecated issue",
|
|
|
|
"details": "...",
|
|
|
|
"level": "warning",
|
|
|
|
"url": "https://docs.elastic.co/..."
|
|
|
|
}
|
|
|
|
],
|
|
|
|
"indices": [
|
|
|
|
{
|
|
|
|
"message": "Index was created before 6.0",
|
|
|
|
"details": "...",
|
|
|
|
"index": "myIndex",
|
|
|
|
"level": "critical",
|
|
|
|
"reindex": true, <1>
|
|
|
|
"url": "https://docs.elastic.co/..."
|
|
|
|
}
|
|
|
|
]
|
|
|
|
}
|
|
|
|
--------------------------------------------------
|
|
|
|
|
2019-09-06 18:09:57 +02:00
|
|
|
<1> To fix indices with the `reindex` attribute, set to `true` using the <<start-resume-reindex, Start or resume reindex API>>.
|