Restart Deployment Elasticsearch Resource
editRestart Deployment Elasticsearch Resource
editRestarts 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.
Request
editPOST /api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/_restart
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
Identifier for the Deployment. |
|
|
Y |
User-specified RefId for the Resource (or '_main' if there is only one). |
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
N |
If true, cancels any pending plans before restarting. If false and there are pending plans, returns an error. |
|
|
N |
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 |
|
|
N |
When set to true and restoring from shutdown, then will restore the cluster from the last snapshot (if available). |
|
|
N |
The time, in seconds, to wait for shards that show no progress of initializing, before rolling the next group (default: 10 minutes) |
|
|
N |
If true, will not take a snapshot of the cluster before restarting. |
Responses
edit-
202
-
(
DeploymentResourceCommandResponse
)The restart command was issued successfully.
-
404
-
-
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
)
Headers
-
x-cloud-error-codes
(string
; allowed values: [deployments.deployment_not_found
,deployments.deployment_resource_not_found
]) - The error codes associated with the response
-
The Deployment specified by {deployment_id} cannot be found. (code:
-
422
-
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
)Headers
-
x-cloud-error-codes
(string
; allowed values: [deployments.deployment_resource_plan_change_error
]) - The error codes associated with the response
-
-
500
-
A Resource that was previously stored no longer exists. (code:
deployments.deployment_resource_no_longer_exists
)Headers
-
x-cloud-error-codes
(string
; allowed values: [deployments.deployment_resource_no_longer_exists
]) - The error codes associated with the response
-
Request example
editcurl -XPOST https://{{hostname}}/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/_restart \ -H "Authorization: ApiKey $ECE_API_KEY"