DescribeIndex

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

使用说明

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

请求说明

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

请求参数

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

Query

返回参数

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

FullTextInfo

KeyValueInfo

Value

请求示例 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"
}

错误码

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