文档首页/云日志服务 LTS/更多文档/API参考（联盟区域）/API/日志流管理/创建日志流索引
更新时间：2026-01-05 GMT+08:00
查看PDF
分享

创建日志流索引

功能介绍

该接口用于向指定日志流创建索引。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

最小长度：36

最大长度：36

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

表3 请求Body参数

参数

是否必选

参数类型

描述

logStreamId

是

String

日志流ID

fullTextIndex

是

LTSFullTextIndexInfo object

全文索引配置

fields

否

Array of LTSFieldsInfo objects

字段索引配置

表4 LTSFullTextIndexInfo

参数

是否必选

参数类型

描述

enable

是

Boolean

是否开启全文索引

caseSensitive

是

Boolean

是否大小写敏感

includeChinese

是

Boolean

是否包含中文

tokenizer

是

String

自定义分词符

最小长度：0

最大长度：128

ascii

否

Array of strings

特殊分词符

最小长度：1

最大长度：3

表5 LTSFieldsInfo

参数

是否必选

参数类型

描述

fieldType

是

String

字段类型

fieldName

是

String

字段名称

最小长度：1

最大长度：256

caseSensitive

否

Boolean

是否大小写敏感

includeChinese

否

Boolean

是否包含中文

tokenizer

是

String

分词符

最小长度：0

最大长度：128

quickAnalysis

否

Boolean

是否快速分析

ascii

否

Array of strings

特殊分词符

响应参数

状态码：200

表6 响应Body参数

参数

参数类型

描述

errorCode

String

错误码

errorMessage

String

错误信息描述

result

String

结果

isQueryComplete

Boolean

是否查询完成

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

调用失败响应信息描述。

状态码：401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

调用失败响应信息描述。

状态码：500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

调用失败响应信息描述。

请求示例

该接口用于向指定日志流创建索引。

POST https://{endpoint}/v1.0/{project_id}/groups/{group_id}/stream/{stream_id}/index/config

{
  "logStreamId" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "fullTextIndex" : {
    "enable" : true,
    "caseSensitive" : false,
    "includeChinese" : false,
    "tokenizer" : ", '\";=()[]{}@&<>/:\\n\\t\\r"
  },
  "fields" : [ {
    "fieldType" : "string",
    "fieldName" : "fieldName1",
    "caseSensitive" : false,
    "includeChinese" : false,
    "tokenizer" : ", '\";=()[]{}@&<>/:\\n\\t\\r",
    "quickAnalysis" : true
  }, {
    "fieldType" : "long",
    "fieldName" : "fieldName2",
    "tokenizer" : ", '\";=()[]{}@&<>/:\\n\\t\\r",
    "quickAnalysis" : true
  }, {
    "fieldType" : "float",
    "fieldName" : "fieldName3",
    "tokenizer" : ", '\";=()[]{}@&<>/:\\n\\t\\r",
    "quickAnalysis" : true
  } ]
}

响应示例

状态码：200

添加索引配置成功

{
  "errorCode" : "SVCSTG.ALS.200200",
  "errorMessage" : "add or update indexConfig successfully",
  "isQueryComplete" : true,
  "result" : "493d04ce-5130-4b07-88be-c5ae3b50bccb"
}

状态码：400

请求参数错误，请根据响应体内容进行修改

{
  "errorCode" : "SVCSTG.ALS.200201",
  "errorMessage" : "IndexConfigInfo check failed.",
  "isQueryComplete" : true
}

状态码：401

认证鉴权失败，排查认证信息是否过期

{
  "error_msg" : "Incorrect IAM authentication information: decrypt token fail",
  "error_code" : "APIGW.0301",
  "request_id" : "b16cc9d789f34cd5196d8df065341788"
}

状态码：500

表示服务后端已经接收到请求，但服务内部处理错误

{
  "error_code" : "LTS.0203",
  "error_msg" : "Internal Server Error"
}

状态码

状态码

描述

200

添加索引配置成功

400

请求参数错误，请根据响应体内容进行修改

401

认证鉴权失败，排查认证信息是否过期

500

表示服务后端已经接收到请求，但服务内部处理错误

错误码

请参见错误码。

父主题：日志流管理