查询日志流索引
功能介绍
查询日志流索引。
调用方法
请参见如何调用API。
URI
GET /v1.0/{project_id}/groups/{group_id}/stream/{stream_id}/index/config
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 从IAM服务获取的用户Token,获取方式请参见:获取用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
Content-Type |
是 |
String |
参数解释: 用于定义消息体的格式,该字段填为:application/json;charset=utf8。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
fullTextIndex |
LTSFullTextIndexInfo object |
全文索引配置 |
fields |
Array of LTSFieldsInfo objects |
字段索引配置 |
logStreamId |
String |
日志流id |
参数 |
参数类型 |
描述 |
---|---|---|
enable |
Boolean |
参数解释: 是否开启全文索引配置。 约束限制: 不涉及。 取值范围: true:开启全文索引配置。 false:不开启全文索引配置。 默认取值: true |
caseSensitive |
Boolean |
参数解释: 开启全文索引配置时,是否区分英文字母的大小写。 约束限制: 不涉及。 取值范围: true:区分英文字母大小写。 false:不区分英文字母大小写。 默认取值: false |
includeChinese |
Boolean |
参数解释: 开启全文索引配置时,是否包含中文。 约束限制: 不涉及。 取值范围: true:包含中文。 false:不包含中文。 默认取值: false |
tokenizer |
String |
参数解释: 分词符。根据指定分词符,将日志内容拆分成多个词;当默认设置不能满足需求时,可以自定义设置分词符。 约束限制: 不涉及。 取值范围: 最小长度:0 最大长度:128 默认取值: , '";=()[]{}@&<>/:\n\t\r |
ascii |
Array of strings |
参数解释: 特殊分词符,参考ASCII码对照表输入ASCII值和控制字符。 约束限制: 不涉及。 取值范围: 最小长度:1 最大长度:3 默认取值: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
fieldType |
String |
参数解释: 字段索引配置时,日志的字段类型。 约束限制: 不涉及。 取值范围:
默认取值: string |
fieldName |
String |
参数解释: 字段索引配置时,日志的字段名称。 约束限制:
取值范围: 示例日志中的字段。 默认取值: 不涉及。 |
caseSensitive |
Boolean |
参数解释: 字段索引配置时,是否开启大小写。 约束限制: 不涉及。 取值范围:
默认取值: false |
includeChinese |
Boolean |
参数解释: 字段索引配置时,是否包含中文。 约束限制: 不涉及。 取值范围:
默认取值: false |
tokenizer |
String |
参数解释: 自定义分词符。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: , '";=()[]{}@&<>/:\?\n\t\r |
quickAnalysis |
Boolean |
参数解释: 字段索引配置时,是否开启快速分析。 约束限制:
取值范围: 默认取值: true |
ascii |
Array of strings |
参数解释: 特殊分词符。 约束限制: 不涉及。 |
ltsSubFieldsInfoList |
Array of LTSSubFieldsInfo objects |
参数解释: 字段索引配置中字段类型为json时的字段信息。 约束限制: 不涉及。 |
fieldAnalysisAlias |
String |
参数解释: 别名,设置别名后,只支持使用别名进行SQL搜索分析,不支持使用别名进行关键字搜索。 约束限制: 不涉及。 取值范围: 长度不能大于256。 默认取值: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
fieldType |
String |
参数解释: 字段索引配置时,日志的字段类型。 约束限制: 不涉及。 取值范围:
默认取值: string |
fieldName |
String |
参数解释: 字段索引配置时,日志的字段名称。 约束限制:
取值范围: 示例日志中的字段。 默认取值: 不涉及。 |
quickAnalysis |
Boolean |
参数解释: 字段索引配置时,是否开启快速分析。 约束限制:
取值范围: 默认取值: true |
fieldAnalysisAlias |
String |
参数解释: 别名,设置别名后,只支持使用别名进行SQL搜索分析,不支持使用别名进行关键字搜索。 约束限制: 不涉及。 取值范围: 长度不能大于256。 默认取值: 不涉及。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码,请参见:错误码。 取值范围: 不涉及。 |
error_msg |
String |
参数解释: 调用失败响应信息描述。 取值范围: 不涉及。 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
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。 表明服务端能被请求访问到,但是服务内部出错。 |
错误码
请参见错误码。