Set size overrides

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

Applies size overrides for the given instances belonging to the given resource. Instance size overrides will be reset with the next plan change.

Path parameters

deployment_id string Required

Identifier for the Deployment.
resource_kind string Required

The kind of resource. Only Elasticsearch resources are currently supported.
ref_id string Required

User-specified RefId for the Resource (or '_main' if there is only one).
instance_ids array[string] Required

A comma-separated list of instance identifiers.

Query parameters

restart_after_update boolean

After overrides are set, restarts the instance to apply the changes.

Default value is false.
ignore_missing boolean

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.

Default value is false.

Body 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].

capacity integer(int32)

Sets the memory capacity for the instances container. Requires a restart to take effect.
storage_multiplier number(double)

Overrides the disk quota multiplier for the instance

Responses

200

The updated overrides
Hide response attributes Show response attributes object
- capacity integer(int32)
  
  Sets the memory capacity for the instances container. Requires a restart to take effect.
- storage_multiplier number(double)
  
  Overrides the disk quota multiplier for the instance
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)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Values are deployments.deployment_not_found, deployments.deployment_resource_not_found, deployments.instances_missing_on_update_error, or instance_overrides.out_of_range.
Hide response attribute Show response attribute object
- errors array[object] Required
  
  A list of errors that occurred in the failing request
  
  Hide errors attributes Show errors attributes object
  
  code string Required
  
  A structured code representing the error type that occurred
  
  message string Required
  
  A human readable message describing the error that occurred
  
  fields array[string]
  
  If the error can be tied to a specific field or fields in the user request, this lists those fields

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

curl \
 -X PUT https://{{hostname}}/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/instances/{instance_ids}/overrides \
 -d '{"capacity":42,"storage_multiplier":42.0}'

Request examples

{
  "capacity": 42,
  "storage_multiplier": 42.0
}

Response examples (200)

{
  "capacity": 42,
  "storage_multiplier": 42.0
}

Response examples (404)

# Headers
x-cloud-error-codes: deployments.deployment_not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}