修改索引
最近更新时间: 2024-10-18 10:38:40
1. 接口描述
接口请求域名: cls.api3.fincloud.tencent.cn。
本接口用于修改索引配置
默认接口请求频率限制:20次/秒。
接口更新时间:2022-10-31 11:10:35。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
参数名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Action | 是 | 否 | String | 公共参数,本接口取值:ModifyIndex |
Version | 是 | 否 | String | 公共参数,本接口取值:2020-10-16 |
Region | 是 | 否 | String | 公共参数,详见产品支持的地域列表(TODO) |
TopicId | 是 | 否 | String | 日志主题ID |
Status | 否 | 否 | Bool | 默认不生效 |
Rule | 否 | 否 | RuleInfo | 索引规则,Rule和Effective两个必须有一个参数存在 |
IncludeInternalFields | 否 | 否 | Bool | 全文索引系统预置字段标记,默认false。 false:不包含系统预置字段, true:包含系统预置字段 |
MetadataFlag | 否 | 否 | Uint64 | 元数据相关标志位,默认为0。 0:全文索引包括开启键值索引的元数据字段, 1:全文索引包括所有元数据字段,2:全文索引不包括元数据字段。 |
CoverageField | 否 | 否 | String | 自定义日志解析异常存储字段。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
错误码 | 描述 |
---|---|
InvalidParameter | |
MissingParameter | |
InternalError | |
FailedOperation | |
ResourceNotFound.TopicNotExist | |
OperationDenied.ACLFailed | |
FailedOperation.TopicIsolated | |
ResourceNotFound.IndexNotExist | |
OperationDenied.AccountIsolate | |
OperationDenied.AccountDestroy | |
OperationDenied.AccountNotExists | |
InvalidParameter.InValidIndexRuleForSearchLow |