Move instancesedit
Moves one or more instances belonging to a Apm cluster.
Requestedit
POST /api/v1/clusters/apm/{cluster_id}/instances/{instance_ids}/_move
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
The APM deployment identifier. |
|
|
Y |
A comma-separated list of instance identifiers. |
Query parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
N |
When |
|
|
N |
When |
|
|
N |
When |
Request bodyedit
(TransientApmPlanConfiguration
) Overrides defaults for the move, including setting the configuration of instances specified in the path
Responsesedit
-
202
-
(
ClusterCommandResponse
) The move is in progress. To monitor progress, use theGET
command on the /{cluster_id} resource. -
400
-
(
BasicFailedReply
) The APM server plan contains errors. (code: 'clusters.cluster_invalid_plan' and 'clusters.plan_feature_not_implemented') -
403
-
(
BasicFailedReply
) The move command is prohibited for the APM server. -
404
-
(
BasicFailedReply
) One or more {instance_id} can't be found. (code: 'clusters.instances_not_found') -
449
-
(
BasicFailedReply
) Elevated permissions are required. (code: '"root.needs_elevated_permissions"')
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/clusters/apm/{cluster_id}/instances/{instance_ids}/_move \ -u $CLOUD_USER:$CLOUD_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" ] } ], "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" : {} } } '