Help Center/ Cloud Search Service/ API Reference (Kuala Lumpur Region)/ API V1/ Logstash/ Forcibly Restarting VMs in a Cluster
Updated on 2026-09-02 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Forcibly Restarting VMs in a Cluster

Function

This API is used to forcibly restart VMs in a Logstash cluster. The cluster becomes unavailable during restart. Exercise caution. During the restart of a running cluster, the Logstash process is automatically stopped. If Keepalive is disabled for pipelines, restarting the cluster will stop all running pipelines. If Keepalive is enabled, Logstash will try restoring these pipelines. If Logstash is restarted within 10 minutes, the pipelines will be restored to running. Otherwise, their status will change to failed.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/reboot

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 target cluster. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

Constraints

N/A

Range

The value is a UUID containing 36 characters.

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Forcibly restart VMs in a cluster.

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

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

400

Invalid request.

Modify the request instead of retrying.

409

The request cannot be processed due to a conflict.

This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.

412

The server does not meet one of the requirements that the requester puts on the request.

Error Codes

See Error Codes.

Parent topic: Logstash