创建索引

最近更新时间: 2026-09-17 00:06:37

1. 接口描述

接口请求域名： cls.api3.fincloud.tencent.cn。

本接口用于创建索引

默认接口请求频率限制：20次/秒。

接口更新时间：2025-01-01 04:48:55。

接口既验签名又鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：CreateIndex
Version	是	否	String	公共参数，本接口取值：2020-10-16
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
TopicId	是	否	String	日志主题ID 示例值： 3edc8551-111b-473b-9fc4-ed66e20dfa8a
Status	否	否	Bool	是否生效，默认为true。true表示索引生效，false表示索引不生效。示例值： true
Rule	是	否	RuleInfo	索引规则示例值：查看
IncludeInternalFields	否	否	Bool	内置保留字段（FILENAME，HOSTNAME__及__SOURCE）是否包含至全文索引，默认为false，推荐设置为true false:不包含 true:包含示例值： true
MetadataFlag	否	否	Uint64	元数据字段（前缀为__TAG__的字段）是否包含至全文索引，默认为0，推荐设置为1 0:仅包含开启键值索引的元数据字段 1:包含所有元数据字段 2:不包含任何元数据字段示例值： 0
CoverageField	否	否	String	自定义日志解析异常存储字段。示例值： RAWLOG

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InvalidParameter	参数错误。
MissingParameter	缺少参数错误。
InternalError	内部错误。
LimitExceeded	超过配额限制。
FailedOperation	操作失败。
ResourceNotFound.TopicNotExist	日志主题不存在。
FailedOperation.TopicIsolated	日志主题已隔离。
InvalidParameter.IndexConflict	指定日志主题已经存在索引规则。
OperationDenied.AccountIsolate	账户欠费。
OperationDenied.AccountDestroy	账户已销毁。
OperationDenied.AccountNotExists	账户不存在。
InvalidParameter.InValidIndexRuleForSearchLow	低频不支持配置kv和tag索引。

5. 示例

示例1 创建索引

输入示例

POST / HTTP/1.1
Host: cls.api.com
Content-Type: application/json
X-TC-Action: CreateIndex
<公共请求参数>

{
    "TopicId": "3edc8551-111b-473b-9fc4-ed66e20dfa8a",
    "Status": true,
    "Rule": {
        "FullText": {
            "CaseSensitive": true,
            "Tokenizer": "*"
        },
        "KeyValue": {
            "CaseSensitive": true,
            "KeyValues": [
                {
                    "Key": "age",
                    "Value": {
                        "Type": "long",
                        "Tokenizer": "_",
                        "SqlFlag": false
                    }
                }
            ],
            "TemplateType": "static"
        },
        "Tag": {
            "CaseSensitive": true,
            "KeyValues": [
                {
                    "Key": "tag",
                    "Value": {
                        "Type": "string",
                        "Tokenizer": "**",
                        "SqlFlag": false
                    }
                }
            ]
        }
    }
}

输出示例

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