文档首页> 云搜索服务 CSS> API参考> Logstash接口> 查询配置文件内容
更新时间：2024-04-22 GMT+08:00
查看PDF

查询配置文件内容

功能介绍

该接口用于查询配置文件内容。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

cluster_id

是

String

指定查询集群ID。
表2 Query参数

参数

是否必选

参数类型

描述

name

是

String

配置文件名称。

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

name

String

配置文件名称。

status

String

配置文件状态。

confContent

String

配置文件内容。

setting

setting object

具体的配置内容对象。

updateAt

String

更新时间。
表4 setting

参数

参数类型

描述

workers

Integer

并行执行管道的Filters+Outputs阶段的工作线程数，默认值为CPU核数。

batchSize

Integer

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

batchDelayMs

Integer

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

queueType

String

用于事件缓冲的内部队列模型。memory为基于内存的传统队列，persisted为基于磁盘的ACKed持久化队列，默认值为memory。

queueCheckPointWrites

Integer

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

queueMaxBytesMb

Integer

如果使用持久化队列，则表示持久化队列的总容量（以兆字节MB为单位），确保磁盘的容量大于该值，默认值为1024。

请求示例

无

响应示例

状态码： 200

请求已成功。

{
  "name" : "conf1",
  "status" : "available",
  "confContent" : "xxxxxxxx",
  "setting" : {
    "workers" : 2,
    "batchSize" : 125,
    "batchDelayMs" : 50,
    "queueType" : "persisted",
    "queueCheckPointWrites" : 1024,
    "queueMaxBytesMb" : 1024
  },
  "updateAt" : "2021-09-29T02:44:44"
}

状态码

状态码

描述

200

请求已成功。

400

非法请求。

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

409

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

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

412

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

错误码

请参见错误码。

父主题： Logstash接口