tencent cloud



Last updated: 2022-08-23 15:21:26

1. API Description

Domain name for API request: cls.tencentcloudapi.com.

This API is used to get the index configuration information.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeIndex.
Version Yes String Common Params. The value used for this API: 2020-10-16.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
TopicId Yes String Log topic ID

3. Output Parameters

Parameter Name Type Description
TopicId String Log topic ID
Status Boolean Whether it takes effect
Rule RuleInfo Index configuration information
Note: this field may return null, indicating that no valid values can be obtained.
ModifyTime String Index modification time. The default value is the index creation time.
IncludeInternalFields Boolean Internal field marker of full-text index. Default value: false. Valid value: false: excluding internal fields; true: including internal fields
Note: This field may return null, indicating that no valid value was found.
MetadataFlag Integer Metadata flag. Default value: 0. Valid value: 0: full-text index (including the metadata field with key-value index enabled); 1: full-text index (including all metadata fields); 2: full-text index (excluding metadata fields).
Note: This field may return null, indicating that no valid value was found.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting index information

Input Example

Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIndex
<Common request parameters>

    "TopicId": "826f8b26-b054-4a0d-8c8e-f3d609f5e0ea"

Output Example

    "Response": {
        "TopicId": "826f8b26-b054-4a0d-8c8e-f3d609f5e0ea",
        "Status": true,
        "Rule": {
            "FullText": {
                "CaseSensitive": false,
                "Tokenizer": "-=/?"
            "KeyValue": {
                "CaseSensitive": false,
                "KeyValues": [
                        "Key": "age",
                        "Value": {
                            "Type": "long",
                            "SqlFlag": true
            "Tag": {
                "CaseSensitive": false,
                "KeyValues": [
                        "Key": "__TAG__.timestamp",
                        "Value": {
                            "Type": "long",
                            "SqlFlag": true
        "ModifyTime": "2021-01-13 21:00:08",
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7",
        "IncludeInternalFields": true,
        "MetadataFlag": 1

5. Developer Resources


TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed.
FailedOperation.TopicIsolated The log topic has been isolated.
InternalError Internal error.
InvalidParameter Incorrect parameter.
MissingParameter Missing parameter.
OperationDenied Operation denied.
OperationDenied.ACLFailed ACL verification failed.
OperationDenied.AccountDestroy The account has been terminated.
OperationDenied.AccountIsolate The account has overdue payments.
OperationDenied.AccountNotExists The account does not exist.
ResourceNotFound.IndexNotExist The index does not exist.
ResourceNotFound.TopicNotExist The log topic does not exist.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support