Help Center/ Cloud Search Service/ API Reference/ API V1/ Logstash/ Querying the Pipeline List

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

View PDF

Querying the Pipeline List

Function

This API is used to query the pipeline list. You can obtain the pipeline configuration file name, status, and update time to verify the configuration file.

Calling Method

For details, see Calling APIs.

URI

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

**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 cluster you want to query. 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** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Definition: The start value of the query. Constraints: N/A Value range: 0-1000 Default value: 0
limit	No	Integer	Definition: Number of pipelines to be queried. The default value is 10, indicating that 10 pipelines are queried at a time. Constraints: N/A Value range: 1-1000 Default value: 10

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
pipelines	Array of pipelines objects	Definition: Pipeline list. Value range: N/A

**Table 4** pipelines
Parameter	Type	Description
name	String	Definition: Configuration file name. Value range: N/A
status	String	Parameter description: Pipeline status. Options: available: The pipeline is available. unavailable: The pipeline is unavailable. working: The pipeline is working. checking: The pipeline is being verified. failed: The pipeline failed. starting: The pipeline is being started. stopping: The pipeline is being stopped. restoring: The pipeline is being restored. stopped: The pipeline has stopped.
keepAlive	Boolean	Definition: Whether to enable the keepalive function. Value range: true: enable keepalive. false: disable keepalive.
events	String	Definition: Event. Value range: 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	Definition: Update time. Value range: N/A

Example Requests

Query the list of pipelines of a Logstash cluster.

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

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.