Restart cluster
editRestart cluster
editThis endpoint is deprecated and scheduled to be removed in the next major version. Use restart Elasticsearch resource instead.
Restarts the Elasticsearch cluster. When you restart an active cluster, the existing plan is used and a cluster_reboot
is applied. A cluster_reboot
issues an Elasticsearch restart command, then waits for the command to complete. When you restart an inactive cluster, the most recent successful plan is applied.
Request
editPOST /api/v1/clusters/elasticsearch/{cluster_id}/_restart
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
The Elasticsearch cluster identifier. |
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
N |
When |
|
|
N |
Specifies the properties that divide the instances into groups. To restart all of the instances, use '__all__'. To restart the instances by logical zone, use '__zone__'. To restart one instance at a time, use '__name__', or use a comma-separated list of instance attributes. |
|
|
N |
When |
|
|
N |
The time, in seconds, to wait for shards that show no progress of initializing, before rolling the next group (default: 10 minutes) |
|
|
N |
When |
Responses
edit-
202
-
The stop command was issued successfully, use the "GET" command on the /{cluster_id} resource to monitor progress
-
400
-
The cluster specified by {cluster_id} is unable to restart. (code:
clusters.restart.failed
)Headers
-
x-cloud-error-codes
(string
; allowed values: [clusters.restart.failed
]) - The error codes associated with the response
-
-
404
-
The cluster specified by {cluster_id} cannot be found. (code:
clusters.cluster_not_found
)Headers
-
x-cloud-error-codes
(string
; allowed values: [clusters.cluster_not_found
]) - The error codes associated with the response
-
-
412
-
The command sent to a cluster found the cluster in an illegal state, the error message gives more details. (code:
clusters.cluster_plan_state_error
)Headers
-
x-cloud-error-codes
(string
; allowed values: [clusters.cluster_plan_state_error
]) - The error codes associated with the response
-
-
449
-
Elevated permissions are required. (code:
root.unauthorized.rbac.elevated_permissions_required
)Headers
-
x-cloud-error-codes
(string
; allowed values: [root.unauthorized.rbac.elevated_permissions_required
]) - The error codes associated with the response
-
Request example
editcurl -XPOST https://{{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/_restart \ -H "Authorization: ApiKey $ECE_API_KEY"