Restarts an Elasticsearch Resource. If a Resource is active: this command re-applies the existing plan but applies a "cluster_reboot", which issues a restart command and waits for it to complete. If a Resource is inactive: this command starts it up with the most recent successful plan.
When set to true and restoring from shutdown, then will restore the cluster from the last snapshot (if available).
skip_snapshotboolean · default: true
If true, will not take a snapshot of the cluster before restarting.
cancel_pendingboolean · default: false
If true, cancels any pending plans before restarting. If false and there are pending plans, returns an error.
group_attributestring · default: __zone__
Indicates the property or properties used to divide the list of instances to restart in groups. Valid options are: '__all__' (restart all at once), '__zone__' by logical zone, '__name__' one instance at a time, or a comma-separated list of attributes of the instances
shard_init_wait_timeinteger · default: 600
The time, in seconds, to wait for shards that show no progress of initializing, before rolling the next group (default: 10 minutes)
List of warnings generated from validating command
codestringrequired
A structured code representing the error type that occurred
messagestring
A human readable message describing the warning that occurred
The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)
The Resource specified by {ref_id} cannot be found. (code: deployments.deployment_resource_not_found)
application/json
errorsobject[]required
A list of errors that occurred in the failing request
codestringrequired
A structured code representing the error type that occurred
messagestringrequired
A human readable message describing the error that occurred
fieldsstring[]
If the error can be tied to a specific field or fields in the user request, this lists those fields
Response headers
x-cloud-error-codesenum
The error codes associated with the response
The command sent to a Resource found the Resource in an illegal state, the error message gives more details. (code: deployments.deployment_resource_plan_change_error)
application/json
errorsobject[]required
A list of errors that occurred in the failing request
codestringrequired
A structured code representing the error type that occurred
messagestringrequired
A human readable message describing the error that occurred
fieldsstring[]
If the error can be tied to a specific field or fields in the user request, this lists those fields
Response headers
x-cloud-error-codesenum
The error codes associated with the response
A Resource that was previously stored no longer exists. (code: deployments.deployment_resource_no_longer_exists)
application/json
errorsobject[]required
A list of errors that occurred in the failing request
codestringrequired
A structured code representing the error type that occurred
messagestringrequired
A human readable message describing the error that occurred
fieldsstring[]
If the error can be tied to a specific field or fields in the user request, this lists those fields