Move instances (advanced)edit
This endpoint is deprecated and scheduled to be removed in the next major version.
Moves one or more Kibana instances. The custom configuration settings are posted in the body.
Requestedit
POST /api/v1/clusters/kibana/{cluster_id}/instances/_move
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
The Kibana deployment identifier. |
Query parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
N |
When |
|
|
N |
When |
Request bodyedit
(TransientKibanaPlanConfiguration
) (required) Overrides defaults for the move, including setting the configuration of instances specified in the path
Responsesedit
-
202
-
The move command was issued successfully, use the "GET" command on the /{cluster_id} resource to monitor progress
-
400
-
-
The cluster definition contained errors. (code:
clusters.cluster_invalid_plan
) -
The cluster definition contained errors. (code:
clusters.plan_feature_not_implemented
)
Headers
-
x-cloud-error-codes
(string
; allowed values: [clusters.cluster_invalid_plan
,clusters.plan_feature_not_implemented
]) - The error codes associated with the response
-
The cluster definition contained errors. (code:
-
403
-
The move command was prohibited for the given cluster. (code:
clusters.command_prohibited
)Headers
-
x-cloud-error-codes
(string
; allowed values: [clusters.command_prohibited
]) - The error codes associated with the response
-
-
404
-
-
The cluster specified by {cluster_id} cannot be found. (code:
clusters.cluster_not_found
) -
One or more of the instances specified at {instance_ids} could not be found. (code:
clusters.instances_not_found
)
Headers
-
x-cloud-error-codes
(string
; allowed values: [clusters.cluster_not_found
,clusters.instances_not_found
]) - The error codes associated with the response
-
The cluster specified by {cluster_id} cannot be found. (code:
-
449
-
Elevated permissions are required. (code:
root.unauthorized.rbac.elevated_permissions_required
)Headers
-
x-cloud-error-codes
(string
; allowed values: [root.unauthorized.rbac.elevated_permissions_required
]) - The error codes associated with the response
-
Request exampleedit
curl -XPOST https://{{hostname}}/api/v1/clusters/kibana/{cluster_id}/instances/_move \ -H "Authorization: ApiKey $ECE_API_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" ] } ], "override_failsafe" : true, "preferred_allocators" : [ "string" ], "reallocate_instances" : true, "timeout" : 0 }, "strategy" : { "autodetect" : {}, "grow_and_shrink" : {}, "rolling" : { "allow_inline_resize" : true, "group_by" : "string", "shard_init_wait_time" : 0, "skip_synced_flush" : true }, "rolling_grow_and_shrink" : {} } } '