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 clusters by typeedit
Moves the clusters, by type, to a different allocator.
Requestedit
POST /api/v1/platform/infrastructure/allocators/{allocator_id}/clusters/{cluster_type}/_move
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
The allocator identifier. |
|
|
N |
The cluster types to move off of the allocator. NOTE: When unspecified, all clusters are moved. |
Query parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
N |
When |
|
|
N |
When true, cancels and overwrites pending plans, or treats instance as an error |
|
|
N |
When true, bypasses the cluster state changes, but continues to move the specified instances |
|
|
N |
When |
Request bodyedit
(MoveClustersRequest
) Overrides defaults for the move of each cluster
Responsesedit
-
202
-
(
MoveClustersCommandResponse
) The move command was issued successfully, use the "GET" command on each /{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
) -
403
-
(
BasicFailedReply
) The move command was prohibited for the given cluster. (code:clusters.command_prohibited
) -
449
-
(
BasicFailedReply
) Elevated permissions are required. (code:root.unauthorized.rbac.elevated_permissions_required
)
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request exampleedit
curl -XPOST {{hostname}}/api/v1/platform/infrastructure/allocators/{allocator_id}/clusters/{cluster_type}/_move \ -u $CLOUD_USER:$CLOUD_KEY \ -H 'Content-Type: application/json' \ -d ' { "apm_clusters" : [ { "cluster_ids" : [ "string" ], "plan_override" : { "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" : {} } } } ], "elasticsearch_clusters" : [ { "cluster_ids" : [ "string" ], "plan_override" : { "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" : [ null ], "move_instances" : [ null ], "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 }, "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" : null } } ], "kibana_clusters" : [ { "cluster_ids" : [ "string" ], "plan_override" : { "plan_configuration" : { "calm_wait_time" : 0, "cluster_reboot" : "string", "extended_maintenance" : true, "move_allocators" : [ null ], "move_instances" : [ null ], "preferred_allocators" : [ "string" ], "reallocate_instances" : true, "timeout" : 0 }, "strategy" : null } } ] } '