查询结构化配置
功能介绍
该接口用于查询指定日志流下的结构化配置内容。
URI
GET /v2/{project_id}/lts/struct/template
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 最小长度:32 最大长度:32 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
logGroupId |
是 |
String |
日志组ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 最小长度:36 最大长度:36 |
logStreamId |
是 |
String |
日志流ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 最小长度:36 最大长度:36 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token,获取方式请参见:获取用户Token 最小长度:1000 最大长度:2000 |
Content-Type |
是 |
String |
该字段填为:application/json;charset=UTF-8。 最小长度:30 最大长度:30 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
demoFields |
Array of StructFieldInfoReturn objects |
结构化字段 |
tagFields |
Array of tag_fields_info objects |
关键词详细信息 |
demoLog |
String |
示例日志 |
demoLabel |
String |
参考日志属性 |
id |
String |
结构化配置id |
logGroupId |
String |
日志组ID |
rule |
ShowStructTemplateRule object |
结构化方式 |
cluster_info |
kafka信息 |
|
logStreamId |
String |
日志流ID |
projectId |
String |
项目ID |
templateName |
String |
模板名称 |
regex |
String |
正则表达式 |
参数 |
参数类型 |
描述 |
---|---|---|
fieldName |
String |
字段名称 |
type |
String |
字段数据类型 |
content |
String |
字段内容 |
isAnalysis |
Boolean |
是否解析 |
index |
Integer |
字段序号 |
参数 |
参数类型 |
描述 |
---|---|---|
fieldName |
String |
字段名称 |
type |
String |
字段类型 |
content |
String |
内容 |
isAnalysis |
Boolean |
是否解析 |
index |
Integer |
字段序号 |
参数 |
参数类型 |
描述 |
---|---|---|
cluster_name |
String |
kafka集群名称 |
kafka_bootstrap_servers |
String |
kafka集群的服务器地址 |
kafka_ssl_enable |
Boolean |
kafka是否开启ssl加密认证 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
调用失败响应信息描述。 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
调用失败响应信息描述。 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
调用失败响应信息描述。 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
调用失败响应信息描述。 |
请求示例
GET https://{endpoint}/v2/{project_id}/lts/struct/template?logGroupId=123456&logStreamId=654321
响应示例
状态码:200
请求响应成功, 成功获取结构化配置。
{ "demoFields" : [ { "content" : "100.19.10.178", "fieldName" : "authority", "index" : 0, "isAnalysis" : true, "type" : "string" }, { "content" : "0", "fieldName" : "bytes_received", "index" : 0, "isAnalysis" : true, "type" : "string" }, { "content" : "1127", "fieldName" : "bytes_sent", "index" : 0, "isAnalysis" : true, "type" : "string" } ] }
状态码:400
BadRequest。非法请求。 建议根据error_msg直接修改该请求,不要重试该请求。
{ "errorCode" : "SVCSTG.ALS.200201", "errorMessage" : "Query Param is error." }
状态码:401
AuthFailed。鉴权失败, 请确认token后再次请求 。
{ "error_code" : "LTS.0414", "error_msg" : "Invalid token" }
状态码:403
Forbidden。请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。
{ "error_code" : "LTS.0001", "error_msg" : "Invalid projectId" }
状态码:500
InternalServerError。
表明服务端能被请求访问到,但是服务内部出错。
{ "error_code" : "LTS.0102", "error_msg" : "Query empty." }
状态码
状态码 |
描述 |
---|---|
200 |
请求响应成功, 成功获取结构化配置。 |
400 |
BadRequest。非法请求。 建议根据error_msg直接修改该请求,不要重试该请求。 |
401 |
AuthFailed。鉴权失败, 请确认token后再次请求 。 |
403 |
Forbidden。请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 |
500 |
InternalServerError。 表明服务端能被请求访问到,但是服务内部出错。 |
503 |
ServiceUnavailable。 被请求的服务无效, 服务不可用。 |
错误码
请参见错误码。