1. 接口描述
接口请求域名： cls.api3.fincloud.tencent.cn。
本接口用于获取索引配置信息
默认接口请求频率限制：20次/秒。
接口更新时间：2025-01-15 00:21:58。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeIndex |
| Version | 是 | 否 | String | 公共参数，本接口取值：2020-10-16 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| TopicId | 是 | 否 | String | 日志主题ID 示例值： 826f8b26-b054-4a0d-8c8e-f3d609f5e0ea |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TopicId | String | 日志主题ID 示例值： 826f8b26-b054-4a0d-8c8e-f3d609f5e0ea |
| Status | Bool | 是否生效。true表示索引生效，false表示索引失效。 示例值： true |
| Rule | RuleInfo | 索引配置信息 示例值：查看 |
| ModifyTime | String | 索引修改时间，初始值为索引创建时间。 示例值： 2021-01-13 21:00:08 |
| IncludeInternalFields | Bool | 内置保留字段（FILENAME，HOSTNAME__及__SOURCE）是否包含至全文索引 false:不包含 true:包含 示例值： true |
| MetadataFlag | Uint64 | 元数据字段（前缀为__TAG__的字段）是否包含至全文索引 0:仅包含开启键值索引的元数据字段 1:包含所有元数据字段 2:不包含任何元数据字段 示例值： 1 |
| CoverageField | String | 自定义日志解析异常存储字段。 示例值： ROWLOG |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| MissingParameter | 缺少参数错误。 |
| InternalError | 内部错误。 |
| FailedOperation | 操作失败。 |
| OperationDenied | 操作被拒绝。 |
| ResourceNotFound.TopicNotExist | 日志主题不存在。 |
| OperationDenied.ACLFailed | ACL校验失败。 |
| FailedOperation.TopicIsolated | 日志主题已隔离。 |
| ResourceNotFound.IndexNotExist | 索引不存在。 |
| OperationDenied.AccountIsolate | 账户欠费。 |
| OperationDenied.AccountDestroy | 账户已销毁。 |
| OperationDenied.AccountNotExists | 账户不存在。 |