Help Center/ Cloud Search Service/ API Reference/ API V1/ Cluster Management/ Restarting a Cluster (Deprecated)
Updated on 2025-11-28 GMT+08:00
View PDF

Restarting a Cluster (Deprecated)

Function

This API is used to restart the data nodes of an Elasticsearch or OpenSearch cluster. Services will be interrupted during the restart. To restart all nodes or other types of nodes in a cluster, you are advised to use Restarting a Cluster V2.

Constraints

If a cluster is available, ensure that it has stopped processing service requests, such as importing and searching for data. Otherwise, data may be lost when the cluster is restarted.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/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

Value range:

Project ID of the account.

Default value:

N/A

cluster_id

Yes

String

Definition:

ID of the cluster you want to restart. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

Constraints:

N/A

Value range:

Cluster ID.

Default value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Restart the data nodes of a cluster.

POST https://{Endpoint}/v1.0/{project_id}/clusters/47e49a5e-8ced-4d0d-ae15-2af62ac468e3/restart

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

400

Invalid request.

Modify the request before retry.

404

The requested resource could not be found.

Modify the request before retry.

Error Codes

See Error Codes.

Parent topic: Cluster Management