tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

ModifyIndex

最后更新时间：2024-04-15 19:58:37

    1. API Description

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

    This API is used to modify the index configuration. It is subject to the default request frequency limit, and the number of concurrent requests to the same log topic cannot exceed 1, i.e., the index configuration of only one log topic can be modified at a time.

    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: ModifyIndex.
    Version Yes String Common Params. The value used for this API: 2020-10-16.
    Region No String Common Params. This parameter is not required for this API.
    TopicId Yes String Log topic ID
    Status No Boolean It does not take effect by default
    Rule No RuleInfo Index rule
    IncludeInternalFields No Boolean Whether full-text indexing includes internal fields (__FILENAME__, __HOSTNAME__, and __SOURCE__). Default value: false. Recommended value: true.
    * false: Full-text indexing does not include internal fields.
    * true: Full-text indexing includes internal fields.
    MetadataFlag No Integer Whether full-text indexing includes metadata fields (which are prefixed with __TAG__). Default value: 0. Recommended value: 1.
    * 0: Full-text indexing includes only metadata fields with key-value indexing enabled.
    * 1: Full-text indexing includes all metadata fields.
    * 2: Full-text indexing does not include metadata fields.

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Modifying Index

    Input Example

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

{
    "TopicId": "826f8b26-b054-4a0d-8c8e-f3d609f5e0ea",
    "Rule": {
        "FullText": {
            "CaseSensitive": false,
            "Tokenizer": "-=/?"
        },
        "Tag": {
            "CaseSensitive": false,
            "KeyValues": [
                {
                    "Value": {
                        "Type": "long",
                        "SqlFlag": true
                    },
                    "Key": "timestamp"
                }
            ]
        },
        "KeyValue": {
            "CaseSensitive": false,
            "KeyValues": [
                {
                    "Value": {
                        "Type": "long",
                        "SqlFlag": true
                    },
                    "Key": "age"
                }
            ]
        }
    },
    "Status": true,
}

    Output Example

    {
    "Response": {
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
    }
}

    5. Developer Resources

    SDK

    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.InValidIndexRuleForSearchLow IA storage does not support key-value or tag index configuration.
    FailedOperation.TopicIsolated The log topic has been isolated.
    InternalError Internal error.
    InvalidParameter Incorrect parameter.
    InvalidParameter.InValidIndexRuleForSearchLow IA storage does not support key-value or tag index configuration.
    LimitExceeded.IndexOperating Index operations exceed the frequency limit.
    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.
    UnsupportedOperation Unsupported operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款