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 allocator identifier.

Query parameters

allocator_down
(boolean; default: false) When true, considers all instances on the allocator as permanently shut down when deciding how to migrate data to new nodes.When left blank, the system automatically decides. NOTE: The default treats the allocator as up.
force_update
(boolean; default: false) When true, cancels and overwrites the pending plans, or treats the instance as an error.
move_only
(boolean; default: false) When true, moves the specified instances and ignores the changes for the cluster state. |
validate_only
(boolean; default: false) When true, validates the plan overrides, then returns the plan 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"')