Help Center/ Cloud Search Service/ API Reference/ API V1/ Logstash/ Hot Stopping Pipeline Data Migration

Updated on 2025-12-26 GMT+08:00

View PDF

Hot Stopping Pipeline Data Migration

This API is used to hot stop pipeline data migration.

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 Value range: Project ID of the account. 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 Value range: Cluster ID. Default value: N/A

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Configuration file name

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.