1. 接口描述
接口请求域名: cls.tencentcloudapi.com 。
本接口用于创建索引
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateIndex。 |
Version | 是 | String | 公共参数,本接口取值:2020-10-16。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
TopicId | 是 | String | 日志主题ID 示例值:3edc8551-111b-473b-9fc4-ed66e20dfa8a |
Rule | 是 | RuleInfo | 索引规则 |
Status | 否 | Boolean | 是否生效,默认为true 示例值:true |
IncludeInternalFields | 否 | Boolean | 内置保留字段(__FILENAME__ ,__HOSTNAME__ 及__SOURCE__ )是否包含至全文索引,默认为false,推荐设置为true* false:不包含 * true:包含 示例值:true |
MetadataFlag | 否 | Integer | 元数据字段(前缀为__TAG__ 的字段)是否包含至全文索引,默认为0,推荐设置为1* 0:仅包含开启键值索引的元数据字段 * 1:包含所有元数据字段 * 2:不包含任何元数据字段 示例值:0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建索引
输入示例
POST / HTTP/1.1
Host: cls.tencentcloudapi.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
}
}
]
},
"Tag": {
"CaseSensitive": true,
"KeyValues": [
{
"Key": "tag",
"Value": {
"Type": "string",
"Tokenizer": "**",
"SqlFlag": false
}
}
]
}
}
}
输出示例
{
"Response": {
"RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.InValidIndexRuleForSearchLow | 低频不支持配置kv和tag索引。 |
FailedOperation.TopicIsolated | 日志主题已隔离。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.InValidIndexRuleForSearchLow | 低频不支持配置kv和tag索引。 |
InvalidParameter.IndexConflict | 指定日志主题已经存在索引规则。 |
LimitExceeded | 超过配额限制。 |
LimitExceeded.IndexOperating | 索引操作超过频率限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.AccountDestroy | 账户已销毁。 |
OperationDenied.AccountIsolate | 账户欠费。 |
OperationDenied.AccountNotExists | 账户不存在。 |
ResourceNotFound.IndexNotExist | 索引不存在。 |
ResourceNotFound.TopicNotExist | 日志主题不存在。 |
UnsupportedOperation | 操作不支持。 |