调用 DescribeIndex 接口获取索引配置信息。

使用说明

此接口的调用频率限制为 20 次/s，超出频率限制会报错 ExceedQPSLimit。

请求说明

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
TopicId	String	是	4a**********	日志主题 ID。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
TopicId	String	4a**********	日志主题 ID。
FullText	Object of FullTextInfo	/	全文索引配置。说明此字段可能返回 null，表示未开启全文索引。
KeyValue	Array of KeyValueInfo	/	键值索引配置。说明此字段返回长度为 0 的数组，表示未开启键值索引。
UserInnerKeyValue	Array of KeyValueInfo	/	预留字段索引配置。说明此字段返回长度为 0 的数组，表示未开启预留字段索引。
CreateTime	String	2021-08-19 11:41:29	索引创建的时间。
ModifyTime	String	2021-08-19 11:41:29	索引最近修改的时间。
EnableAutoIndex	Boolean	true	是否开启索引自动更新，开启后系统将根据新出现的字段自动添加到键值索引。 true：开启自动更新。 false：不开启自动更新。
EnablePhraseIndex	Boolean	false	是否开启短语查询索引版功能，开启后使用双引号即可用于精准匹配指定的短语，进行短语查询。 true：开启。 false：不开启。
MaxTextLen	Integer	2048	统计字段值的最大长度，默认为 2048，取值范围为 64~1048576，单位为字节。说明单个字段值的长度超过您所指定的最大长度时，超出部分将被截断，不参与分析。字段最大长度更新后，只对增量数据有效。

FullTextInfo

参数	类型	示例值	描述
Delimiter	String	, ;/\n\t	全文索引的分词符。
CaseSensitive	Boolean	false	是否大小写敏感。 true：大小写敏感。 false：大小写不敏感。
IncludeChinese	Boolean	false	是否包含中文。 true：包含中文。 false：不包含中文。

KeyValueInfo

参数	类型	示例值	描述
Key	String	"Key": "test-key1"	键值索引的字段名称。
Value	Object of Value	"Value": { "ValueType": "text", "Delimiter": "", "CaseSensitive": true, "IncludeChinese": false, "SqlFlag": false }	键值索引的字段信息。

Value

参数	类型	示例值	描述
SqlFlag	Boolean	false	字段是否开启分析功能。 true：开启。 false：未开启。
IndexAll	Boolean	false	是否为 JSON 字段中所有值为文本的字段创建索引。 ture：开启。 false：未开启。
JsonKeys	Array of KeyValueInfo	[ { "Key":"key1", "Value":{ "ValueType":"text", "SqlFlag":true } }, { "Key":"key2", "Value":{ "ValueType":"long", "SqlFlag":true } }, { "Key":"key3.key4.key5", "Value":{ "ValueType":"double", "SqlFlag":true } } ]	返回 JSON 子字段的索引，其值为 KeyValueInfo 数组。
Delimiter	String	, ;/\n\t	字段的分词符。
ValueType	String	text	字段类型，包括long、double、text 和 json。
CaseSensitive	Boolean	true	是否大小写敏感。 true：大小写敏感。 false：大小写不敏感。
IncludeChinese	Boolean	false	是否包含中文。 true：包含中文。 false：不包含中文。
Description	String	test	索引字段的描述信息。
IndexSQLAll	Boolean	false	是否为 JSON 字段开启自动索引和统计功能。 true：开启自动索引和统计功能。 false：不开启自动索引和统计功能。
AutoIndexFlag	Boolean	false	该索引是否是自动索引添加。 true：该索引为自动添加。 false：该索引非自动添加。

请求示例 1

返回示例 1

仅配置全文索引

请求示例 2

返回示例 2

仅配置字段索引

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HTTP 状态码	错误码	错误信息	说明
400	InvalidArgument	Invalid argument key %s, value %s, please check argument.	参数不合法。
404	TopicNotExist	Topic does not exist.	日志主题不存在。
404	IndexNotExist	Index does not exist.	索引配置不存在。
500	InternalServerError	We encountered an unexpected server error, please try again later.	服务器内部错误。