文档首页/ 云日志服务 LTS/ 更多文档/ API参考（联盟区域）/ API/ 云端结构化配置/ 查询结构化配置
更新时间：2026-01-05 GMT+08:00
查看PDF
分享

查询结构化配置

功能介绍

该接口用于查询指定日志流下的结构化配置内容。

URI

GET /v2/{project_id}/lts/struct/template

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见：获取项目ID，获取账号ID，日志组ID、日志流ID

最小长度：32

最大长度：32
表2 Query参数

参数

是否必选

参数类型

描述

logGroupId

是

String

日志组ID，获取方式请参见：获取项目ID，获取账号ID，日志组ID、日志流ID

最小长度：36

最大长度：36

logStreamId

是

String

日志流ID，获取方式请参见：获取项目ID，获取账号ID，日志组ID、日志流ID

最小长度：36

最大长度：36

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

从IAM服务获取的用户Token，获取方式请参见：获取用户Token

最小长度：1000

最大长度：2000

Content-Type

是

String

该字段填为：application/json;charset=UTF-8。

最小长度：30

最大长度：30

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

demoFields

Array of StructFieldInfoReturn objects

从日志解析出的结构化字段信息。

tagFields

Array of tagFieldsInfo objects

根据日志的上报渠道生成的固有字段信息或用户手动配置的静态字段信息。

demoLog

String

示例日志

demoLabel

String

字段已废弃，使用结构化模板时，返回值为‘{}’。

id

String

结构化配置id

logGroupId

String

日志组ID

rule

ShowStructTemplateRule object

结构化方式

logStreamId

String

日志流ID

projectId

String

项目ID

templateName

String

模板名称

regex

String

该字段已弃用。

custom_time_info

custom_time_info object

自定义时间字段信息。

sql_analysis_enable

Boolean

是否开启日志分析功能（该字段功能被索引配置的同名字段覆盖）。

uploadOriginalLog

String

是否上报原始日志。

uploadParseFailedLog

String

是否上报解析失败日志。
表5 StructFieldInfoReturn

参数

参数类型

描述

fieldName

String

字段名称

type

String

字段数据类型

content

String

字段内容

isAnalysis

Boolean

是否解析

index

Integer

字段序号

isLabelField

Boolean

废弃字段，不再使用。

isModified

Boolean

废弃字段，不再使用。
表6 tagFieldsInfo

参数

参数类型

描述

fieldName

String

字段名称

type

String

字段类型

content

String

内容

isAnalysis

Boolean

是否解析

index

Integer

字段序号

isModified

String

废弃字段，不再使用。
表7 ShowStructTemplateRule

参数

参数类型

描述

param

String

结构化参数

type

String

结构化类型。regex为旧版正则结构化参数，已不可创建，对应功能被custom_regex、regex_auto参数取代。

取值范围：

  • regex

  • json

  • split

  • nginx

  • built_in

  • custom_regex

  • regex_auto
表8 custom_time_info

参数

参数类型

描述

enable

Boolean

是否启用自定义上报时间开关。

key

String

解析为上报时间的结构化字段。

time_format

String

用于将结构化字段解析为时间类型的格式信息。

value

String

解析为时间的结构化字段的示例。

状态码：400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

调用失败响应信息描述。

状态码：401

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

调用失败响应信息描述。

状态码：403

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

调用失败响应信息描述。

状态码：500

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

调用失败响应信息描述。

请求示例

GET https://{endpoint}/v2/{project_id}/lts/struct/template?logGroupId=123456&logStreamId=654321

响应示例

状态码：200

请求响应成功, 成功获取结构化配置。

{
  "custom_time_info" : {
    "enable" : false,
    "key" : "",
    "value" : ""
  },
  "demoFields" : [ {
    "content" : "127.0.0.1:8080",
    "end" : "26",
    "fieldName" : "ip",
    "index" : 0,
    "isAnalysis" : true,
    "isLabelField" : false,
    "isModified" : false,
    "start" : "20",
    "type" : "string"
  } ],
  "demoLabel" : "{}",
  "demoLog" : "https://127.0.0.1:8080",
  "id" : "a0a12b069ab4491185d7cf26c3e86ada_86b572f8-11df-4361-b48e-b3861c3c761c_b7ce2abf-1625-42eb-89ea-cb396de4bb15",
  "logGroupId" : "86b572f8-11df-4361-b48e-b3861c3c761c",
  "logStreamId" : "b7ce2abf-1625-42eb-89ea-cb396de4bb15",
  "projectId" : "a0a12b069abxxxx185d7cf26c3e86ada",
  "rule" : {
    "param" : "{\"keyObject\":{\"1\":\"ip\"},\"regex_rules\":\"^(?:[^\\\\.]*\\\\.){1}(\\\\w+)\"}",
    "type" : "regex_auto"
  },
  "sql_analysis_enable" : true,
  "tagFields" : [ {
    "content" : "",
    "fieldName" : "tag1",
    "index" : 0,
    "isAnalysis" : true,
    "isModified" : false,
    "type" : "string"
  } ],
  "uploadOriginalLog" : true,
  "uploadParseFailedLog" : false
}

状态码：400

非法请求。 建议根据error_msg直接修改该请求，不要重试该请求。

{
  "error_code" : "SVCSTG.ALS.200201",
  "error_msg" : "Query Param is error."
}

状态码：401

鉴权失败, 请确认token后再次请求 。

{
  "error_code" : "LTS.0414",
  "error_msg" : "Invalid token"
}

状态码：403

请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。

{
  "error_code" : "LTS.0001",
  "error_msg" : "Invalid projectId"
}

状态码：500

表明服务端能被请求访问到，但是服务内部出错。

{
  "error_code" : "LTS.0102",
  "error_msg" : "Query empty."
}

状态码

状态码

描述

200

请求响应成功, 成功获取结构化配置。

400

非法请求。 建议根据error_msg直接修改该请求，不要重试该请求。

401

鉴权失败, 请确认token后再次请求 。

403

请求被拒绝访问。返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。

500

表明服务端能被请求访问到，但是服务内部出错。

503

被请求的服务无效, 服务不可用。

错误码

请参见错误码。

父主题： 云端结构化配置