Move Elasticsearch resource instancesedit
Moves one or more instances belonging to the given Elasticsearch resource to a different allocator.
Requestedit
POST /api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/instances/{instance_ids}/_move
Path parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
Identifier for the Deployment. |
|
|
Y |
A comma-separated list of instance identifiers. |
|
|
Y |
User-specified RefId for the Resource. |
Query parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
N |
When |
|
|
N |
When |
|
|
N |
When |
|
|
N |
When |
|
|
N |
When |
Request bodyedit
(TransientElasticsearchPlanConfiguration) Overrides the default move configuration
Responsesedit
-
200 -
(
TransientElasticsearchPlanConfiguration)If
validate_onlyistrue, the calculated plan is returned -
202 -
The move command was issued successfully. Use the "GET" command on the /{deployment_id} resource to monitor progress
-
404 -
-
The Deployment specified by {deployment_id} cannot be found. (code:
deployments.deployment_not_found) -
The Elasticsearch Resource specified by {ref_id} cannot be found. (code:
deployments.deployment_resource_not_found) -
One or more instances of the given resource type are missing. (code:
deployments.instances_missing_on_update_error)
Headers
-
x-cloud-error-codes(string; allowed values: [deployments.deployment_not_found,deployments.deployment_resource_not_found,deployments.instances_missing_on_update_error]) - The error codes associated with the response
-
The Deployment specified by {deployment_id} cannot be found. (code:
-
449 -
Elevated permissions are required. (code:
root.unauthorized.rbac.elevated_permissions_required)Headers
-
x-cloud-error-codes(string; allowed values: [root.unauthorized.rbac.elevated_permissions_required]) - The error codes associated with the response
-
Request exampleedit
curl -XPOST https://{{hostname}}/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/instances/{instance_ids}/_move \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
"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" : [
{
"allocator_down" : true,
"from" : "string",
"to" : [
"string"
]
}
],
"move_instances" : [
{
"from" : "string",
"instance_down" : true,
"to" : [
"string"
]
}
],
"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
},
"remote_clusters" : {
"resources" : [
{
"alias" : "string",
"deployment_id" : "string",
"elasticsearch_ref_id" : "string",
"info" : {
"compatible" : true,
"connected" : true,
"healthy" : true,
"trusted" : true,
"trusted_back" : true
},
"skip_unavailable" : true
}
]
},
"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" : {
"autodetect" : {},
"grow_and_shrink" : {},
"rolling" : {
"allow_inline_resize" : true,
"group_by" : "string",
"shard_init_wait_time" : 0,
"skip_synced_flush" : true
},
"rolling_grow_and_shrink" : {}
}
}
'