Help Center/ Cloud Search Service/ API Reference/ APIs/ Logstash/ Hot Starting Pipeline Data Migration
Updated on 2024-10-17 GMT+08:00

Hot Starting Pipeline Data Migration

Function

This API is used to hot start the pipeline data migration.

Debugging

You can debug this API through automatic authentication in API Explorer.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.

cluster_id

Yes

String

ID of the target cluster

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Configuration file name

keep_alive

No

Boolean

During hot start, the Keepalive setting is inherited from existing pipes in the cluster.

  • true: Enable the Keepalive function.

  • false: Disable the Keepalive function.

    Keepalive can be enabled for services that need to run for a long time. After this function is 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.

Response Parameters

None

Example Requests

POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/lgsconf/hot-start

{
  "keep_alive" : false,
  "name" : "confName1"
}

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.