本文导读

功能介绍
调用方法
URI
请求参数
响应参数
请求示例
响应示例
状态码
错误码

展开导读

文档首页/ 云日志服务 LTS/ API参考/ API说明/ 日志流管理/ 查询日志流索引

查询日志流索引

更新时间：2025-04-24 GMT+08:00

在线调试

CLI示例

查看PDF

功能介绍

查询日志流索引。

调用方法

请参见如何调用API。

URI

GET /v1.0/{project_id}/groups/{group_id}/stream/{stream_id}/index/config

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，获取方式请参见：获取项目ID，获取账号ID，日志组ID、日志流ID 最小长度：32 最大长度：32
group_id	是	String	日志组ID，获取方式请参见：获取项目ID，获取账号ID，日志组ID、日志流ID 最小长度：36 最大长度：36
stream_id	是	String	日志流ID，获取方式请参见：获取项目ID，获取账号ID，日志组ID、日志流ID 最小长度：36 最大长度：36

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	从IAM服务获取的用户Token，获取方式请参见：获取用户Token
Content-Type	是	String	该字段填为：application/json;charset=UTF-8

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
fullTextIndex	LTSFullTextIndexInfo object	全文索引配置
fields	Array of LTSFieldsInfo objects	字段索引配置
logStreamId	String	日志流id

表4 LTSFullTextIndexInfo
参数	参数类型	描述
enable	Boolean	是否开启全文索引
caseSensitive	Boolean	是否大小写敏感
includeChinese	Boolean	是否包含中文
tokenizer	String	自定义分词符最小长度：0 最大长度：128
ascii	Array of strings	特殊分词符最小长度：1 最大长度：3

表5 LTSFieldsInfo
参数	参数类型	描述
fieldType	String	字段类型。枚举值： string long float json
fieldName	String	字段名称。最小长度：1 最大长度：256
caseSensitive	Boolean	是否大小写敏感。缺省值：false
includeChinese	Boolean	是否包含中文。缺省值：false
tokenizer	String	分词符。最小长度：0 最大长度：128
quickAnalysis	Boolean	是否快速分析。缺省值：false
ascii	Array of strings	特殊分词符。
ltsSubFieldsInfoList	Array of LTSSubFieldsInfo objects	json字段信息。
fieldAnalysisAlias	String	日志分析和统计图表可以使用的索引别名。

表6 LTSSubFieldsInfo
参数	参数类型	描述
fieldType	String	字段类型。枚举值： string long float
fieldName	String	字段名称。最小长度：1 最大长度：256
quickAnalysis	Boolean	是否快速分析。缺省值：false
fieldAnalysisAlias	String	日志分析和统计图表可以使用的子字段别名。

状态码：400

表7 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。取值范围：不涉及。
error_msg	String	参数解释：调用失败响应信息描述。取值范围：不涉及。

状态码：500

表8 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。取值范围：不涉及。
error_msg	String	参数解释：调用失败响应信息描述。取值范围：不涉及。

请求示例

查询当前租户下指定日志流下的索引配置内容。请求参数为路径参数，不提供请求示例。

响应示例

状态码：200

请求响应成功，查询索引配置成功。

{
  "logStreamId" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "fullTextIndex" : {
    "ascii" : [ ],
    "tokenizer" : ", '\";=()[]{}@&<>/:\\n\\t\\r",
    "enable" : true,
    "caseSensitive" : true,
    "includeChinese" : false
  },
  "fields" : [ {
    "ascii" : [ ],
    "tokenizer" : ", '\";=()[]{}@&<>/:\\\\?\\n\\t\\r",
    "fieldName" : "field1",
    "caseSensitive" : false,
    "includeChinese" : true,
    "quickAnalysis" : true,
    "fieldType" : "string",
    "ltsSubFieldsInfoList" : null
  }, {
    "ascii" : [ ],
    "tokenizer" : ", '\";=()[]{}@&<>/:\\\\?\\n\\t\\r",
    "fieldName" : "field2",
    "caseSensitive" : false,
    "includeChinese" : true,
    "quickAnalysis" : true,
    "fieldType" : "string",
    "ltsSubFieldsInfoList" : null
  } ]
}

状态码：400

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

{
  "errorCode" : "SVCSTG.ALS.200201",
  "errorMessage" : "Query Param is error."
}

状态码：500

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

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

状态码


状态码	描述
200	请求响应成功，查询索引配置成功。
400	BadRequest。非法请求。建议根据error_msg直接修改该请求，不要重试该请求。
500	InternalServerError。表明服务端能被请求访问到，但是服务内部出错。

错误码

请参见错误码。

父主题：日志流管理

上一篇：修改日志流

下一篇：日志管理

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问