Restart Deployment Elasticsearch Resource
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.
Path parameters
-
Identifier for the Deployment.
-
User-specified RefId for the Resource (or '_main' if there is only one).
Query parameters
-
restore_snapshot boolean
When set to true and restoring from shutdown, then will restore the cluster from the last snapshot (if available).
Default value is
true
. -
skip_snapshot boolean
If true, will not take a snapshot of the cluster before restarting.
Default value is
true
. -
cancel_pending boolean
If true, cancels any pending plans before restarting. If false and there are pending plans, returns an error.
Default value is
false
. -
group_attribute string
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
Default value is
__zone__
. -
shard_init_wait_time integer
The time, in seconds, to wait for shards that show no progress of initializing, before rolling the next group (default: 10 minutes)
Default value is
600
.
Responses
-
The restart command was issued successfully.
-
- 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
)
- The Deployment specified by {deployment_id} cannot be found. (code:
-
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
) -
A Resource that was previously stored no longer exists. (code:
deployments.deployment_resource_no_longer_exists
)
curl \
-X POST https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/_restart
{
"warnings": [
{
"code": "string",
"message": "string"
}
]
}
# Headers
x-cloud-error-codes: deployments.deployment_not_found
# Payload
{
"errors": [
{
"code": "string",
"message": "string",
"fields": [
"string"
]
}
]
}
# Headers
x-cloud-error-codes: deployments.deployment_resource_plan_change_error
# Payload
{
"errors": [
{
"code": "string",
"message": "string",
"fields": [
"string"
]
}
]
}
# Headers
x-cloud-error-codes: deployments.deployment_resource_no_longer_exists
# Payload
{
"errors": [
{
"code": "string",
"message": "string",
"fields": [
"string"
]
}
]
}