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 instancesedit
DEPRECATED (Scheduled to be removed in the next major version): Moves one or more instances in the Elasticsearch cluster.
Requestedit
POST /api/v1/clusters/elasticsearch/{cluster_id}/instances/{instance_ids}/_move
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
The Elasticsearch cluster identifier. |
|
|
Y |
A comma-separated list of instance identifiers. |
Query parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
N |
When |
|
|
N |
When |
|
|
N |
When |
|
|
N |
When |
|
|
N |
When |
Request bodyedit
(TransientElasticsearchPlanConfiguration
) Overrides defaults for the move, including setting the configuration of instances specified in the path
Responsesedit
-
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
) * 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
-
-
403
-
(
BasicFailedReply
) 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
-
(
BasicFailedReply
) * 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
-
-
449
-
(
BasicFailedReply
) 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/elasticsearch/{cluster_id}/instances/{instance_ids}/_move \ -H "Authorization: ApiKey $ECE_API_KEY" \ -H 'Content-Type: application/json' \ -d ' { "cluster_settings_json" : {}, "plan_configuration" : { "calm_wait_time" : 0, "cluster_reboot" : "string", "extended_maintenance" : true, "max_snapshot_age" : 0, "max_snapshot_attempts" : 0, "move_allocators" : [ { "allocator_down" : true, "from" : "string", "to" : [ "string" ] } ], "move_instances" : [ { "from" : "string", "instance_down" : true, "to" : [ "string" ] } ], "move_only" : true, "override_failsafe" : true, "preferred_allocators" : [ "string" ], "reallocate_instances" : true, "skip_data_migration" : true, "skip_post_upgrade_steps" : true, "skip_snapshot" : true, "skip_snapshot_post_major_upgrade" : true, "skip_upgrade_checker" : true, "timeout" : 0 }, "remote_clusters" : { "resources" : [ { "alias" : "string", "deployment_id" : "string", "elasticsearch_ref_id" : "string", "info" : { "compatible" : true, "connected" : true, "healthy" : true, "trusted" : true, "trusted_back" : true }, "skip_unavailable" : true } ] }, "restore_snapshot" : { "repository_config" : { "raw_settings" : {} }, "repository_name" : "string", "restore_payload" : { "indices" : [ "string" ], "raw_settings" : {} }, "snapshot_name" : "string", "source_cluster_id" : "string", "strategy" : "string" }, "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" : {} } } '