Set size overrides | Elastic Cloud Enterprise Reference [3.3]

A newer version is available. For the latest information, see the current release documentation.

› › › ›

« Stop maintenance mode Capture a new on-demand heap dump for the given instance »

Set size overridesedit

Applies size overrides for the given instances belonging to the given resource.

Requestedit

PUT /api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/overrides

Path parametersedit

Name	Type	Required	Description
`deployment_id`	`string`	Y	Identifier for the Deployment.
`instance_ids`	`array[string]`	Y	A comma-separated list of instance identifiers.
`ref_id`	`string`	Y	User-specified RefId for the Resource.
`resource_kind`	`string`	Y	The kind of resource. Only Elasticsearch resources are currently supported.

Query parametersedit

Name	Type	Required	Description
`ignore_missing`	`boolean`; default: `false`	N	When `false` and a specified instance is missing, will return an error and not update any instances. When `true` will update only existing instances and not treat a missing instance as an error.
`restart_after_update`	`boolean`; default: `false`	N	After overrides are set, restarts the instance to apply the changes.

Request bodyedit

(InstanceOverrides) (required) The overrides to apply to the given instances. Capacity overrides the RAM size in MB of the instance, and storage multipler overrides the multiplier of the instance RAM size that determines the storage quota of the instance. Capacity must be in the range [1024, 65536] and storage multiplier must be in the range [1.0, 1000.0].

Responsesedit

200

(InstanceOverrides)

The updated overrides

404

(BasicFailedReply)

The deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)
The Resource specified by {ref_id} cannot by found. (code: deployments.deployment_resource_not_found)
One or more instances weren't found, and ignore_missing is false or unspecified. (code: deployments.instances_missing_on_update_error)
The specified override was out of range. Capacity must be in the range [1024, 65536] and storage multiplier must be in the range [1.0, 1000.0]. (code: instance_overrides.out_of_range)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_not_found, deployments.deployment_resource_not_found, deployments.instances_missing_on_update_error, instance_overrides.out_of_range]): The error codes associated with the response

449

(BasicFailedReply)

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 -XPUT https://{{hostname}}/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/overrides \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "capacity" : 0,
   "storage_multiplier" : 0.1
}
'

« Stop maintenance mode Capture a new on-demand heap dump for the given instance »