Move instances (advanced) | Elastic Cloud Enterprise Reference [2.2]

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.

› › › ›

« Upgrade cluster Start all instances »

Move instances (advanced)edit

Moves one or more Kibana instances. The custom configuration settings are posted in the body.

Requestedit

POST /api/v1/clusters/kibana/{cluster_id}/instances/_move

Path parametersedit

Name	Type	Required	Description
`cluster_id`	`string`	Y	The Kibana deployment identifier.

Query parametersedit

Name	Type	Required	Description
`force_update`	`boolean`; default: `false`	N	When `true`, cancels and overwrites the pending plans, or treats the instance as an error.
`ignore_missing`	`boolean`; default: `false`	N	When `true` and the instance does not exist, proceeds to the next instance, or treats the instance as an error.
`validate_only`	`boolean`; default: `false`	N	When `true`, validates the move request, then returns the calculated plan without applying the plan.

Request bodyedit

(TransientKibanaPlanConfiguration) (required) 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 the GET command on the /{cluster_id} resource.
400: (BasicFailedReply) The Kibana deployment plan contains errors. (code: 'clusters.cluster_invalid_plan' and 'clusters.plan_feature_not_implemented')
403: (BasicFailedReply) The move command is prohibited for the Kibana deployment.
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/kibana/{cluster_id}/instances/_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" : {}
   }
}
'

« Upgrade cluster Start all instances »