It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.
The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Move instances (advanced)
editMove instances (advanced)
editMoves one or more instances belonging to a Kibana cluster, with custom configuration posted in the body
Request
editPOST /api/v1/clusters/kibana/{cluster_id}/instances/_move
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
The Kibana deployment identifier. |
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
N |
When |
|
|
N |
When |
|
|
N |
When |
Request body
edit(TransientKibanaPlanConfiguration
) (required) Overrides defaults for the move, including setting the configuration of instances specified in the path
Responses
edit-
202
-
(
ClusterCommandResponse
) The move command was issued successfully, use the "GET" command on the /{cluster_id} resource to monitor progress -
400
-
(
BasicFailedReply
) The cluster definition contained errors (code: 'clusters.cluster_invalid_plan' and 'clusters.plan_feature_not_implemented') -
403
-
(
BasicFailedReply
) The move command was prohibited for the given cluster -
404
-
(
BasicFailedReply
) One or more of the instances specified at {instance_ids} could not be found (code: 'clusters.instances_not_found') -
449
-
(
BasicFailedReply
) elevated permissions are required. (code: '"root.needs_elevated_permissions"')
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request example
editcurl -XPOST {{hostname}}/api/v1/clusters/kibana/{cluster_id}/instances/_move \ -u $CLOUD_USER:$CLOUD_KEY \ -H 'Content-Type: application/json' \ -d ' { "plan_configuration" : { "calm_wait_time" : 0, "cluster_reboot" : "string", "extended_maintenance" : true, "move_allocators" : [ { "allocator_down" : true, "from" : "string", "to" : [ "string" ] } ], "move_instances" : [ { "from" : "string", "instance_down" : true, "to" : [ "string" ] } ], "preferred_allocators" : [ "string" ], "reallocate_instances" : true, "timeout" : 0 }, "strategy" : { "grow_and_shrink" : {}, "rolling" : { "allow_inline_resize" : true, "group_by" : "string", "shard_init_wait_time" : 0, "skip_synced_flush" : true }, "rolling_grow_and_shrink" : {} } } '