Querying the Pipeline List

Function

This API is used to query the pipeline list.

URI

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

Table 1 Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Parameter description: The project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name. Constraints: N/A Options: For details about how to obtain the project ID and name, see Obtaining the Project ID and Name. Default value: N/A
cluster_id	Yes	String	Parameter description: ID of the cluster you want to query. Constraints: N/A Options: For details about how to obtain the cluster ID, see Obtaining the Cluster ID. Default value: N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters
Parameter	Type	Description
pipelines	Array of pipelines objects	Parameter description: Pipeline list.

Table 3 pipelines
Parameter	Type	Description
name	String	Parameter description: Configuration file name.
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	Parameter description: Whether to enable the keepalive function. Options: true: enable keepalive. false: disable keepalive.
events	String	Parameter description: 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	Parameter description: Update time.

Example Requests

Query the list of pipelines created in a 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.

Error Codes

See Error Codes.

Parent topic: Logstash

Предыдущая статья

Querying the Configuration File List

Следующая статья

Querying Operation Records

Была ли эта статья полезна?

Поддержка Юридические документы