调用 DescribeIndex 接口获取索引配置信息。 ## 使用说明此接口的调用频率限制为 20 次/s，超出频率限制会报错 ExceedQPSLimit。 ## 请求说明 * 请求方式：GET * 请求地址：https://{tls\-endpoint}/DescribeIndex ## 请求参数下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见[公共参数](https://www.volcengine.com/docs/6470/112170)。 ### Query |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |TopicId |String |是 |`4a**********` |日志主题 ID。 | ## 返回参数下表仅列出本接口特有的返回参数。更多信息请参见[返回结构](https://www.volcengine.com/docs/6470/112169)。 |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |TopicId |String |`4a**********` |日志主题 ID。 | |FullText |Object of [FullTextInfo](#fulltextinfo) |`/` |全文索引配置。|\ | | | |:::tip|\ | | | |此字段可能返回 null，表示未开启全文索引。|\ | | | ||\ | | | |:::| |KeyValue |Array of [KeyValueInfo](#keyvalueinfo) |`/` |键值索引配置。|\ | | | |:::tip|\ | | | |此字段返回长度为 0 的数组，表示未开启键值索引。|\ | | | ||\ | | | |:::| |UserInnerKeyValue |Array of [KeyValueInfo](#keyvalueinfo) |`/` |预留字段索引配置。|\ | | | |:::tip|\ | | | |此字段返回长度为 0 的数组，表示未开启预留字段索引。|\ | | | ||\ | | | |:::| |CreateTime |String |`2021-08-19 11:41:29` |索引创建的时间。 | |ModifyTime |String |`2021-08-19 11:41:29` |索引最近修改的时间。 | |EnableAutoIndex |Boolean |`true` |是否开启索引自动更新，开启后系统将根据新出现的字段自动添加到键值索引。|\ | | | ||\ | | | |* true：开启自动更新。|\ | | | |* false：不开启自动更新。 | |MaxTextLen |Integer |`2048` |统计字段值的最大长度，默认为 2048，取值范围为 64~1048576，单位为字节。|\ | | | |:::tip|\ | | | ||\ | | | |* 单个字段值的长度超过您所指定的最大长度时，超出部分将被截断，不参与分析。|\ | | | |* 字段最大长度更新后，只对增量数据有效。|\ | | | ||\ | | | |:::| ### 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) |`"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](#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：不包含中文。 | |IndexSQLAll |Boolean |`false` |是否为 JSON 字段开启自动索引和统计功能。|\ | | | ||\ | | | |* `true`：开启自动索引和统计功能。|\ | | | |* `false`：不开启自动索引和统计功能。 | |AutoIndexFlag |Boolean |`false` |该索引是否是自动索引添加。|\ | | | ||\ | | | |* true：该索引为自动添加。|\ | | | |* false：该索引非自动添加。 | ## 请求示例 1 ```JSON GET https://{tls-endpoint}/DescribeIndex?TopicId=c1******** HTTP/1.1 ``` ## 返回示例 1 仅配置全文索引 ```JSON { "TopicId": "396f23d6-27bd-48eb-85d8-ee693716****", "FullText": { "Delimiter": ",-;", "CaseSensitive": false, "IncludeChinese": false }, "KeyValue": [], "UserInnerKeyValue": [], "CreateTime": "2022-02-28 21:36:14", "ModifyTime": "2022-02-28 21:36:15" } ``` ## 请求示例 2 ```JSON GET https://{tls-endpoint}/DescribeIndex?TopicId=c1******** HTTP/1.1 Content-Type: application/json ``` ## 返回示例 2 仅配置字段索引 ```JSON Content-Type: application/json; charset=utf-8 { "TopicId": "4a**********", "FullText": { "Delimiter": ", ;/\n\t", "CaseSensitive": false, "IncludeChinese": false }, "KeyValue": [ { "Key": "test-key1", "Value": { "SqlFlag": false, "IndexAll": false, "JsonKeys": [ { "Key": "key1", "Value": { "ValueType": "text", "SqlFlag": true } }, { "Key": "key2", "Value": { "ValueType": "long", "SqlFlag": true } }, { "Key": "key3.key4.key5", "Value": { "ValueType": "double", "SqlFlag": true } } ], "Delimiter": ", ;/\n\t", "ValueType": "text", "IndexSQLAll": false, "AutoIndexFlag": false, "CaseSensitive": true, "IncludeChinese": false } } ], "UserInnerKeyValue": [ { "Key": "inner-key1", "Value": { "SqlFlag": false, "IndexAll": false, "JsonKeys": [], "Delimiter": "", "ValueType": "text", "IndexSQLAll": false, "AutoIndexFlag": false, "CaseSensitive": false, "IncludeChinese": false } } ], "CreateTime": "2021-08-19 11:41:29", "ModifyTime": "2021-08-19 11:41:29", "EnableAutoIndex": true, "MaxTextLen": 2048 } ``` ## 错误码下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见[公共错误码](https://www.volcengine.com/docs/6470/112173)文档。 |**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. |服务器内部错误。 |

日志服务