Help Center/ Cloud Search Service/ API Reference/ API V1/ Logstash/ Starting Pipeline Data Migration
Updated on 2026-10-28 GMT+08:00

Starting Pipeline Data Migration

Function

This API is used to start a data migration pipeline in a Logstash cluster.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/lgsconf/start

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 whose pipeline function you want to enable. 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

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

keep_alive

No

Boolean

Definition

Whether to enable the keepalive function. Keepalive can be enabled for services that need to run for a long time. Once enabled, a daemon process will be configured on each node. If the Logstash service is faulty, the daemon process will automatically start and rectify the fault. Keepalive is not suitable for services that only run for a short period of time. If the Logstash service is started for multiple times, data will be migrated repeatedly.

Constraints

N/A

Range

  • true: Enable the Keepalive function.

  • false: Disable the Keepalive function.

Default Value

false

names

Yes

Array of strings

Definition

Configuration file name. The value can contain 1 to 64 characters. Only letters, digits, and special characters are allowed.

Constraints

N/A

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Start pipeline data migration.

POST https://{Endpoint}/v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/lgsconf/start

{
  "keep_alive" : false,
  "names" : [ "confName1", "confName2", "confName3" ]
}

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

400

Invalid request.

The client should modify the request instead of re-initiating it.

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 did not meet one of the preconditions contained in the request.

Error Codes

See Error Codes.