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

查询配置文件列表

功能介绍

该接口用于查询配置文件列表。

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

账户的项目ID。

默认取值:

不涉及

cluster_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

集群ID。

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释:

指定查询起始值,默认值为1,即从第1个配置开始查询。

约束限制:

不涉及

取值范围:

大于或等于1

默认取值:

1

limit

否

Integer

参数解释:

指定查询个数,默认值为10,即一次查询10个配置信息。

约束限制:

不涉及

取值范围:

1-1000

默认取值:

10

请求参数

无

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

confs

Array of confs objects

配置文件列表。

表4 confs

参数

参数类型

描述

name

String

参数解释:

配置文件名称。

取值范围:

不涉及

status

String

参数解释:

配置文件状态。

取值范围:

  • checking:正在检查中。

  • available:可用。

  • unavailable:不可用。

  • starting:正开始。

  • working:工作中。

  • stopping:正在停止。

  • stopped:已经停止。

  • restoring:正在回滚。

confContent

String

参数解释:

配置文件内容。

取值范围:

不涉及

setting

setting object

参数解释:

具体的配置内容对象。

取值范围:

不涉及

updateAt

String

参数解释:

更新时间。

取值范围:

不涉及

desc

String

参数解释:

配置文件描述。

取值范围:

长度不超过128个字符。

表5 setting

参数

参数类型

描述

workers

Integer

参数解释:

并行执行管道的Filters+Outputs阶段的工作线程数。

约束限制:

不涉及

取值范围:

1-节点CPU核数的5倍

默认取值:

CPU核数。

batch_size

Integer

参数解释:

单个工作线程在尝试执行其Filters和Outputs之前将从inputs收集的最大事件数,该值较大通常更有效,但会增加内存开销。

约束限制:

不涉及

取值范围:

1-100000

默认取值:

125

batch_delay_ms

Integer

参数解释:

每个event被pipeline调度等待的最小时间。单位毫秒。

约束限制:

不涉及

取值范围:

1-600000

默认取值:

50

queue_type

String

参数解释:

用于事件缓冲的内部队列模型。

约束限制:

不涉及

取值范围:

  • memory:基于内存的传统队列。

  • persisted:基于磁盘的ACKed持久化队列。

默认取值:

不涉及

queue_check_point_writes

Integer

参数解释:

如果使用持久化队列,则表示强制执行检查点之前写入的最大事件数。

约束限制:

仅当queue_type=persisted时生效。

取值范围:

1-40960

默认取值:

1024

queue_max_bytes_mb

Integer

参数解释:

如果使用持久化队列,则表示持久化队列的总容量(以兆字节MB为单位),确保磁盘的容量大于该值。

约束限制:

仅当queue_type=persisted时生效

取值范围:

1-100000

默认取值:

1024

请求示例

查询配置文件列表。

GET https://{Endpoint}/v1.0/{project_id}/clusters/5c77b71c-5b35-4f50-8984-76387e42451a/lgsconf/listconfs

响应示例

状态码:200

请求成功。

{
  "confs" : [ {
    "name" : "conf",
    "desc" : "This is a description of a configuration file.",
    "status" : "available",
    "confContent" : "xxxxxxxx",
    "setting" : {
      "workers" : 2
    },
    "updateAt" : "2021-09-29T02:44:44"
  } ]
}

状态码

状态码

描述

200

请求成功。

400

非法请求。

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

409

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

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

412

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

错误码

请参见错误码。