140 lines
3.3 KiB
Plaintext
140 lines
3.3 KiB
Plaintext
[role="xpack"]
|
|
[testenv="basic"]
|
|
[[migration-api-upgrade]]
|
|
=== Migration Upgrade API
|
|
|
|
The Migration Upgrade API performs the upgrade of internal indices to make them
|
|
compatible with the next major version.
|
|
|
|
[float]
|
|
==== Request
|
|
|
|
`POST /_migration/upgrade/<index_name>`
|
|
|
|
[float]
|
|
==== Description
|
|
|
|
Indices must be upgraded one at a time.
|
|
|
|
[float]
|
|
==== Path Parameters
|
|
|
|
`index_name`::
|
|
(string) Identifier for the index.
|
|
|
|
`wait_for_completion`::
|
|
(boolean) Defines whether the upgrade call blocks until the upgrade process is
|
|
finished. The default value is `true`. If set to `false`, the upgrade can be
|
|
performed asynchronously.
|
|
|
|
//==== Query Parameters
|
|
|
|
//==== Authorization
|
|
|
|
[float]
|
|
==== Examples
|
|
|
|
The following example submits a POST request to the
|
|
`/_migration/upgrade/<index_name>` endpoint:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
POST /_migration/upgrade/.watches
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[skip:cannot create an old index in docs test]
|
|
|
|
A successful call returns the statistics about the upgrade process:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
{
|
|
"took" : 127,
|
|
"timed_out" : false,
|
|
"total" : 4,
|
|
"updated" : 0,
|
|
"created" : 4,
|
|
"deleted" : 0,
|
|
"batches" : 1,
|
|
"version_conflicts" : 0,
|
|
"noops" : 0,
|
|
"retries" : {
|
|
"bulk" : 0,
|
|
"search" : 0
|
|
},
|
|
"throttled_millis" : 0,
|
|
"failures" : [ ]
|
|
}
|
|
--------------------------------------------------
|
|
// NOTCONSOLE
|
|
|
|
The following example upgrades a large index asynchronously by specifying the
|
|
`wait_for_completion` parameter:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
POST /_migration/upgrade/.watches?wait_for_completion=false
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[skip:cannot create an old index in docs test]
|
|
|
|
This call should return the id of the upgrade process task:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
{
|
|
"task" : "PFvgv7T6TGumRyFF3vqTFg:1137"
|
|
}
|
|
--------------------------------------------------
|
|
// NOTCONSOLE
|
|
|
|
The status of the running or finished upgrade requests can be obtained by using
|
|
the <<tasks,Task API>>:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
GET _tasks/PFvgv7T6TGumRyFF3vqTFg:1137?detailed=true
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[skip:cannot create an old index in docs test]
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
{
|
|
"completed" : true, <1>
|
|
"task" : {
|
|
"node" : "PFvgv7T6TGumRyFF3vqTFg",
|
|
"id" : 1137,
|
|
"type" : "transport",
|
|
"action" : "cluster:admin/xpack/upgrade",
|
|
"description" : "",
|
|
"start_time_in_millis" : 1500650625413,
|
|
"running_time_in_nanos" : 947456819,
|
|
"cancellable" : true
|
|
},
|
|
"response" : { <2>
|
|
"took" : 212,
|
|
"timed_out" : false,
|
|
"total" : 4,
|
|
"updated" : 0,
|
|
"created" : 4,
|
|
"deleted" : 0,
|
|
"batches" : 1,
|
|
"version_conflicts" : 0,
|
|
"noops" : 0,
|
|
"retries" : {
|
|
"bulk" : 0,
|
|
"search" : 0
|
|
},
|
|
"throttled_millis" : 0,
|
|
"failures" : [ ]
|
|
}
|
|
}
|
|
--------------------------------------------------
|
|
// NOTCONSOLE
|
|
|
|
<1> If the `completed` field value is `true`, the upgrade request has finished.
|
|
If it is `false`, the request is still running.
|
|
|
|
<2> The `response` field contains the status of the upgrade request.
|