Help Center/ Cloud Search Service/ API Reference/ APIs/ Logstash/ Querying the Pipeline List
Updated on 2024-10-17 GMT+08:00

Querying the Pipeline List

Function

This API is used to query the pipeline list.

Debugging

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

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/lgsconf/listpipelines

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 cluster you want to query.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

pipelines

Array of pipelines objects

Pipeline list.

Table 3 pipelines

Parameter

Type

Description

name

String

Configuration file name.

status

String

Pipeline status.

keepAlive

Boolean

Whether to enable the keepalive function.

events

String

Only the events in the running state can be viewed in real time after a manual refresh. For events in the Stopped state, you can check the amount of migrated data at the output terminal.

updateAt

String

Update time.

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "pipelines" : [ {
    "name" : "conf1",
    "status" : "stopped",
    "keepAlive" : false,
    "events" : "xxxxxxxx",
    "updateAt" : "2021-09-29T02:44:44"
  } ]
}

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.