更新时间:2026-09-03 GMT+08:00

查询pipeline列表

功能介绍

该接口用于查询pipeline列表,用户可以得到pipeline的配置文件名称、状态、更新时间等,用于检查配置文件基本情况。此接口只适用于Logstash集群,pipeline列表是配置中心的管道列表,需要先启动配置文件,才能查看pipeline列表。

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID。获取方法请参见获取项目ID和名称。

约束限制:

不涉及

取值范围:

账户的项目ID。

默认取值:

不涉及

cluster_id

是

String

参数解释:

指定查询集群ID。获取方法请参见获取集群ID。

约束限制:

不涉及

取值范围:

集群ID。

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释:

指定查询起始值。

约束限制:

不涉及

取值范围:

大于或等于0

默认取值:

0

limit

否

Integer

参数解释:

指定查询个数。

约束限制:

不涉及

取值范围:

1-1000

默认取值:

默认10,即一次查询10个pipeline信息。

请求参数

无

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

pipelines

Array of pipelines objects

参数解释:

pipeline列表。

取值范围:

不涉及

表4 pipelines

参数

参数类型

描述

name

String

参数解释:

配置文件名称。

取值范围:

不涉及

status

String

参数解释:

pipeline状态。

取值范围:

  • available:表示可用。

  • unavailable:表示不可用。

  • working:表示工作中。

  • checking:表示校验中。

  • failed:表示失败。

  • starting:表示启动中。

  • stopping:表示停止中。

  • restoring:表示恢复中。

  • stopped:表示已停止。

keepAlive

Boolean

参数解释:

是否开启常驻。工作中状态的集群,重启过程会主动停止logstash进程,管道列表“是否保持常驻”值为否,会将所有运行中管道状态置为已停止。“是否保持常驻”值为是,会触发logstash进程恢复机制,将工作中的管道状态置为恢复中,若十分钟内重新拉起logstash进程,管道状态恢复为工作中,否则置为失败状态。

取值范围:

  • true表示开启常驻。

  • false表示不开启常驻。

events

String

参数解释:

迁移事件。事件只有在“工作中”状态才可以实时查看(需要手动刷新),“已停止”状态请到Logstash集群的输出端查看迁移数据量。

取值范围:

不涉及

updateAt

String

参数解释:

管道更新时间。

取值范围:

不涉及

请求示例

查询Logstash集群的pipeline列表。

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

响应示例

状态码:200

请求成功。

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

状态码

状态码

描述

200

请求成功。

400

非法请求。

建议直接修改该请求,不要重试该请求。

409

服务器在完成请求时发生冲突。

返回该状态码,表明客户端尝试创建的资源已经存在,或者由于冲突请求的更新操作不能被完成。

412

未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。

错误码

请参见错误码。