Rolling Restart (Deprecated)

This API is used to perform a rolling restart on a specific type of nodes in an Elasticsearch or OpenSearch cluster.

Rolling restart is supported only when there are more than three nodes (including Master nodes, Client nodes, and cold data nodes) in the cluster. When the cluster is available, ensure that the cluster has stopped processing service data (such as importing and searching for data). Otherwise, data may be lost during cluster restart. During the rolling restart, you need to wait until the restarted nodes are added to the cluster and the index status changes to green. If there are a large number of indexes, the restart takes a long time.

For details, see Calling APIs.

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
css:cluster:rollingReboot	Write	cluster *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	css:cluster:rollingRestart	-

POST /v2.0/{project_id}/clusters/{cluster_id}/rolling_restart

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name. Constraints N/A Range Project ID of an account. The value contains 32 characters, consisting of lowercase letters and digits. Default Value N/A
cluster_id	Yes	String	Definition ID of the cluster to be restarted. For details about how to obtain the cluster ID, see Obtaining the Cluster ID. Constraints The value is a UUID containing 36 characters. Range Cluster ID. Default Value N/A

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
type	Yes	String	Definition Rolling restart type. Only role is supported. Constraints N/A Range role: Restart by role. Default Value N/A
value	Yes	String	Definition Role type. Use commas (,) to separate multiple types. Constraints Select at least one node type from ess, ess-cold, and all. Range ess: data node ess-cold: cold data node ess-client: client node ess-master: master node all: all nodes Default Value N/A

Status code: 200

Request succeeded.

None

Restart a node.

POST https://{Endpoint}/v2.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/rolling_restart

{
  "type" : "role",
  "value" : "ess"
}

None

Status Code	Description
200	Request succeeded.
400	Invalid request. Modify the request before retry.
409	The request could not be completed due to a conflict with the current state of the resource. The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.
412	The server did not meet one of the preconditions contained in the request.

Parent topic: Cluster Management

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.