调用 DescribeIndex 接口获取索引配置信息。
此接口的调用频率限制为 20 次/s，超出频率限制会报错 ExceedQPSLimit。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| 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 | 索引最近修改的时间。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Delimiter | String | , ;/\n\t | 全文索引的分词符。 |
CaseSensitive | Boolean |
| 是否大小写敏感。
|
IncludeChinese | Boolean |
| 是否包含中文。
|
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Key | String | "Key": "test-key1" | 键值索引的字段名称。 |
| Value | Object of Value | "Value": { "ValueType": "text", "Delimiter": "", "CaseSensitive": true, "IncludeChinese": false, "SqlFlag": false } | 键值索引的字段描述信息。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
SqlFlag | Boolean |
| 字段是否开启分析功能。
|
IndexAll | Boolean |
| 是否为 JSON 字段中所有值为文本的字段创建索引。
|
| 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 |
| 是否大小写敏感。
|
IncludeChinese | Boolean |
| 是否包含中文。
|
GET https://tls-{Region}.ivolces.com/DescribeIndex?TopicId=c1******** HTTP/1.1
仅配置全文索引
{ "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" }
GET https://tls-{Region}.ivolces.com/DescribeIndex?TopicId=c1******** HTTP/1.1 Content-Type: application/json
仅配置字段索引
Content-Type: application/json; charset=utf-8 { "TopicId":"39*************", "FullText":null, "KeyValue":[ { "Key":"test1", "Value":{ "ValueType":"text", "Delimiter":"", "CaseSensitive":true, "IncludeChinese":false, "SqlFlag":false } }, { "Key":"test2", "Value":{ "ValueType":"long", "Delimiter":"", "CaseSensitive":false, "IncludeChinese":false, "SqlFlag":true } }, { "Key":"test3", "Value":{ "ValueType":"json", "Delimiter":"", "CaseSensitive":false, "IncludeChinese":false, "SqlFlag":true, "JsonKeys":[ { "Key":"key1", "Value":{ "ValueType":"text", "Delimiter":"", "CaseSensitive":false, "IncludeChinese":false, "SqlFlag":true } }, { "Key":"key2", "Value":{ "ValueType":"long", "Delimiter":"", "CaseSensitive":false, "IncludeChinese":false, "SqlFlag":true } }, { "Key":"key3.key4.key5", "Value":{ "ValueType":"double", "Delimiter":"", "CaseSensitive":false, "IncludeChinese":false, "SqlFlag":true } } ] } }, ... ], "UserInnerKeyValue": [], "CreateTime":"2022-02-28 21:36:14", "ModifyTime":"2022-02-28 21:36:15" }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
| 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. | 服务器内部错误。 |