Move clusters

Moves clusters off an allocator.

Request

POST /api/v1/platform/infrastructure/allocators/{allocator_id}/clusters/_move

Path parameters

allocator_id (required)
(string) The identifier of the allocator of which to move clusters

Query parameters

allocator_down
(boolean; default: false) Tells the infrastructure that all instances on the allocator should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will auto-decide (currently: will treat the allocator as up)
force_update
(boolean; default: false) If true, will cancel any pending plans and overwrite with this move plan for all clusters, else will error
move_only
(boolean; default: false) If true, will ignore any changes that may be needed for cluster state other than moving requested instances
validate_only
(boolean; default: false) If true, will validate the plan overrides and return the plan that would be applied, without performing the move

Request body

(MoveClustersRequest) Overrides defaults for the move of each cluster

Responses

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' and 'clusters.plan_feature_not_implemented')
403
(BasicFailedReply) The move command was prohibited for the given cluster
449
(BasicFailedReply) elevated permissions are required. (code: '"root.needs_elevated_permissions"')