You need to enable JavaScript to run this app.
导航
DescribeIndex
最近更新时间:2024.06.28 14:57:25首次发布时间:2022.05.11 11:26:48

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

使用说明

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

请求说明

  • 请求方式:GET
  • 请求地址:https://tls-{Region}.ivolces.com/DescribeIndex

请求参数

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

Query

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

返回参数

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

参数类型示例值描述
TopicIdString4a**********日志主题 ID。

FullText

Object of FullTextInfo

/

全文索引配置。

说明

此字段可能返回 null,表示未开启全文索引。

KeyValue

Array of KeyValueInfo

/

键值索引配置。

说明

此字段返回长度为 0 的数组,表示未开启键值索引。

UserInnerKeyValue

Array of KeyValueInfo

/

预留字段索引配置。

说明

此字段返回长度为 0 的数组,表示未开启预留字段索引。

CreateTimeString2021-08-19 11:41:29索引创建的时间。
ModifyTimeString2021-08-19 11:41:29索引最近修改的时间。

FullTextInfo

参数类型示例值描述
DelimiterString, ;/\n\t全文索引的分词符。

CaseSensitive

Boolean

false

是否大小写敏感。

  • true:大小写敏感。
  • false:大小写不敏感。

IncludeChinese

Boolean

false

是否包含中文。

  • true:包含中文。
  • false:不包含中文。

KeyValueInfo

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

Value

参数类型示例值描述

SqlFlag

Boolean

false

字段是否开启分析功能。

  • true:开启。
  • false:未开启。

IndexAll

Boolean

false

是否为 JSON 字段中所有值为文本的字段创建索引。

  • ture:开启。
  • false:未开启。
JsonKeysArray 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 数组。
DelimiterString, ;/\n\t字段的分词符。
ValueTypeStringtext字段类型,包括long、double、text 和 json。

CaseSensitive

Boolean

true

是否大小写敏感。

  • true:大小写敏感。
  • false:大小写不敏感。

IncludeChinese

Boolean

false

是否包含中文。

  • true:包含中文。
  • false:不包含中文。

请求示例 1

GET https://tls-{Region}.ivolces.com/DescribeIndex?TopicId=c1******** HTTP/1.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"
}

请求示例 2

GET https://tls-{Region}.ivolces.com/DescribeIndex?TopicId=c1******** HTTP/1.1
Content-Type: application/json

返回示例 2

仅配置字段索引

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 状态码错误码错误信息说明
400InvalidArgumentInvalid argument key %s, value %s, please check argument.参数不合法。
404TopicNotExistTopic does not exist.日志主题不存在。
404IndexNotExistIndex does not exist.索引配置不存在。
500InternalServerErrorWe encountered an unexpected server error, please try again later.服务器内部错误。