You need to enable JavaScript to run this app.
导航

DescribeIndex

最近更新时间2023.11.13 16:31:27

首次发布时间2022.05.11 11:26:48

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

使用说明

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

URI

请求方法
GET

URI

https://tls-{Region}.ivolces.com/DescribeIndex

传输协议

HTTPS

URI请求参数

参数
参数类型
是否必选
示例值
说明

TopicId

String

必选

4a***********

日志主题 ID。

响应参数

参数
类型
示例值
描述

TopicId

String

4a**********

日志主题ID。

FullText

FullTextInfo

/

全文索引配置。详细信息请参考FullTextInfo

说明

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

KeyValue

Array of KeyValueInfo

/

键值索引配置。详细信息请参考 KeyValueInfo

说明

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

UserInnerKeyValue

Array of KeyValueInfo

/

预留字段索引配置。详细信息请参考 KeyValueInfo

说明

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

CreateTime

String

2021-08-19 11:41:29

索引创建的时间。

ModifyTime

String

2021-08-19 11:41:29

索引最近修改的时间。

示例

请求示例

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

响应示例

仅配置全文索引

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8 
...
{
    "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"
}

仅配置字段索引

HTTP/1.1 200 OK
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"
}

错误码

错误码(Code)
HTTP 状态码
错误信息(Message)
说明

InvalidArgument

400

Invalid argument key %s, value %s, please check argument.

参数不合法。

TopicNotExist

404

Topic does not exist.

日志主题不存在。

IndexNotExist

404

Index does not exist.

索引配置不存在。

InternalServerError

500

We encountered an unexpected server error, please try again later.

服务器内部错误。

更多信息,请参考通用错误码