Updated on 2026-09-02 GMT+08:00

Hot Stopping Pipeline Data Migration

This API is used to hot-stop a data migration pipeline in a Logstash cluster.

For details, see Calling APIs.

POST /v1.0/{project_id}/clusters/{cluster_id}/lgsconf/hot-stop

**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

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Definition Configuration file name. Constraints N/A Range Up to 32 characters. Default Value N/A

Status code: 200

Request succeeded.

None

Hot-stop a data migration pipeline.

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

{
  "name" : "confName"
}

None

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.

Parent topic: Logstash