文档首页/ 云搜索服务 CSS/ API参考（联盟区域）/ API V1/ Logstash/ 查询模板列表
更新时间：2026-01-12 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询模板列表

功能介绍

该接口用于查询模板列表。

调用方法

请参见如何调用API。

URI

GET /v1.0/{project_id}/lgsconf/template

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

账户的项目ID。

默认取值：

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

type

否

String

参数解释：

模板类型。

约束限制：

不涉及

取值范围：

  • custom为自定义模板。

  • system为系统模板。

默认取值：

查找自定义模板和系统模板。

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

systemTemplates

Array of systemTemplates objects

系统模板列表。

customTemplates

Array of customTemplates objects

自定义模板列表。
表4 systemTemplates

参数

参数类型

描述

id

String

配置文件ID。

name

String

配置文件名称。

confContent

String

配置文件内容。

desc

String

描述。
表5 customTemplates

参数

参数类型

描述

id

String

配置文件ID。

name

String

配置文件名称。

confContent

String

配置文件内容。

desc

String

描述。

请求示例

查询模板列表。

GET https://{Endpoint}/v1.0/{project_id}/clusters/lgsconf/template?type=custom

响应示例

状态码：200

请求已成功。

{
  "systemTemplates" : [ {
    "id" : "a03b1791-6dc6-453d-961d-88939adc82aa",
    "name" : "elasticsearch",
    "confContent" : "xxxxxxxx",
    "desc" : "logstash config for es"
  } ],
  "customTemplates" : [ {
    "id" : "2e16fbba-49bf-4690-93af-3f89025c6523",
    "name" : "es_to_https_es",
    "confContent" : "xxxxxxxx",
    "desc" : "es到安全集群es"
  } ]
}

状态码

状态码

描述

200

请求已成功。

400

非法请求。

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

409

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

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

412

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

错误码

请参见错误码。

父主题： Logstash