IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Stop maintenance mode (all instances) Start instances »

› › › ›

Set size overrides

edit

Set size overrides

edit

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

Request

edit

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

Path parameters

edit

Name	Type	Required	Description
`deployment_id`	`string`	Y	Identifier for the Deployment.
`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 parameters

edit

Name	Type	Required	Description
`restart_after_update`	`boolean`; default: `false`	N	After overrides are set, restarts the instance to apply the changes.

Request body

edit

(InstanceOverrides) (required) The overrides to apply to all 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].

Responses

edit

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)
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, 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 example

edit

curl -XPUT https://{{hostname}}/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/overrides \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "capacity" : 0,
   "storage_multiplier" : 0.1
}
'

« Stop maintenance mode (all instances) Start instances »