Set size overrides
editSet size overrides
editApplies size overrides for the given instances belonging to the given resource. Instance size overrides will be reset with the next plan change.
Request
editPUT /api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/overrides
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
Identifier for the Deployment. |
|
|
Y |
A comma-separated list of instance identifiers. |
|
|
Y |
User-specified RefId for the Resource (or '_main' if there is only one). |
|
|
Y |
The kind of resource. Only Elasticsearch resources are currently supported. |
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
N |
When |
|
|
N |
After overrides are set, restarts the instance to apply the changes. |
Request body
edit(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].
Responses
edit-
200
-
The updated overrides
-
404
-
-
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
-
The deployment specified by {deployment_id} cannot be found. (code:
Request example
editcurl -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 } '