更新时间:2025-03-21 GMT+08:00

创建日志流索引

功能介绍

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

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" : true,
    "tokenizer" : ", '\";=()[]{}@&<>/:\\n\\t\\r"
  },
  "fields" : [ {
    "fieldType" : "long",
    "fieldName" : "fieldName1"
  }, {
    "fieldType" : "string",
    "fieldName" : "fieldName2",
    "caseSensitive" : false,
    "includeChinese" : true,
    "tokenizer" : "",
    "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

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

错误码

请参见错误码